.. _neuronperf:

.. meta::
   :noindex:
   :nofollow:
   :description: This tutorial for the AWS Neuron SDK is currently archived and not maintained. It is provided for reference only.
   :date-modified: 12-02-2025

=================
NeuronPerf (Beta)
=================

NeuronPerf is a lightweight Python library with a simple API that enables fast measurements of performance when running models using Neuron.

.. _neuronperf_quickstart:

NeuronPerf Quickstart
---------------------

To install NeuronPerf in your Neuron environment, execute:

.. code:: bash

  $ pip install neuronperf --extra-index-url=https://pip.repos.neuron.amazonaws.com


Refer to the :ref:`neuronperf_examples` and :ref:`neuronperf_user_guide` to get started.


.. _neuronperf_user_guide:

NeuronPerf User Guide
---------------------

.. toctree::
   :maxdepth: 1

   Overview <neuronperf_overview>
   Terminology <neuronperf_terminology>
   Examples <neuronperf_examples>
   Benchmark Guide <neuronperf_benchmark_guide>
   Evaluate Guide <neuronperf_evaluate_guide>
   Compile Guide <neuronperf_compile_guide>
   Model Index Guide <neuronperf_model_index_guide>


NeuronPerf API Reference
------------------------

.. toctree::
   :maxdepth: 1

   API <neuronperf_api>
   Framework Notes <neuronperf_framework_notes>


FAQ
---

.. toctree::
   :maxdepth: 1

   FAQ <neuronperf_faq>


Troubleshooting
---------------

.. toctree::
   :maxdepth: 1

   Troubleshooting <neuronperf_troubleshooting>


Release Notes
-------------

.. toctree::
   :maxdepth: 1

   rn