.. advisor documentation master file, created by
   sphinx-quickstart on Fri Apr 21 15:13:20 2017.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to Intel® Advisor Python API Documentation!
=================================================================

.. toctree::
    :maxdepth: 2
    :caption: Contents:

.. automodule:: advisor

API Reference
-------------
.. autofunction:: advisor.open_project(project_path, mpi_rank=-1)

.. autoclass:: Project
    :members:
    :undoc-members:

.. autoclass:: DataModel
    :members:
    :undoc-members:

.. autoclass:: Hotspot
    :members:
    :undoc-members:

.. autoclass:: Site
    :members:
    :undoc-members:

.. autoclass:: Problem
    :members:
    :undoc-members:

.. autoclass:: ProgramMetrics
    :members:
    :undoc-members:


Indices and tables
==================

* :ref:`genindex`
* :ref:`search`
