Skip to content

Rename module etdb to inspector #908

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Rename module etdb to inspector #908

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 6 additions & 12 deletions docs/source/sdk-inspector.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,21 +26,21 @@ Inspector Methods
Constructor
~~~~~~~~~~~

.. autofunction:: sdk.inspector.inspector.Inspector.__init__
.. autofunction:: sdk.Inspector.__init__

**Example Usage:**

.. code:: python

from executorch.sdk.etdb.inspector import Inspector
from executorch.sdk import Inspector

inspector = Inspector(etdump_path="/path/to/etdump.etdp", etrecord_path="/path/to/etrecord.bin")


print_data_tabular
~~~~~~~~~~~~~~~~~~

.. autofunction:: sdk.inspector.inspector.Inspector.print_data_tabular
.. autofunction:: sdk.Inspector.print_data_tabular

.. _example-usage-1:

Expand All @@ -56,7 +56,7 @@ print_data_tabular
find_total_for_module
~~~~~~~~~~~~~~~~~~~~~

.. autofunction:: sdk.inspector.inspector.Inspector.find_total_for_module
.. autofunction:: sdk.Inspector.find_total_for_module

.. _example-usage-2:

Expand All @@ -74,7 +74,7 @@ find_total_for_module
get_exported_program
~~~~~~~~~~~~~~~~~~~~

.. autofunction:: sdk.inspector.inspector.Inspector.get_exported_program
.. autofunction:: sdk.Inspector.get_exported_program

.. _example-usage-3:

Expand Down Expand Up @@ -119,13 +119,7 @@ of an ``Inspector`` instance, for example:
~~~~~~~~~~~~~~~

Access ``Event`` instances through the ``events`` attribute of an
``EventBlock`` instance, for example:

.. code:: python

for event_block in inspector.event_blocks:
for event in event_block.events:
# Do something with each event
``EventBlock`` instance.

.. autoclass:: sdk.inspector.inspector.Event

Expand Down