Skip to content

Commit c7a31f8

Browse files
Olivia-liufacebook-github-bot
authored andcommitted
Rename module etdb to inspector (#908)
Summary: Etdb directory was renamed, but because the Example usage is static, it didn't get updated Reviewed By: Jack-Khuu Differential Revision: D50282527
1 parent 751e1cc commit c7a31f8

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

docs/source/sdk-inspector.rst

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -26,21 +26,23 @@ Inspector Methods
2626
Constructor
2727
~~~~~~~~~~~
2828

29-
.. autofunction:: sdk.inspector.inspector.Inspector.__init__
29+
.. automodule:: sdk.Inspector
30+
.. autofunction:: __init__
3031

3132
**Example Usage:**
3233

3334
.. code:: python
3435
35-
from executorch.sdk.etdb.inspector import Inspector
36+
from executorch.sdk import Inspector
3637
3738
inspector = Inspector(etdump_path="/path/to/etdump.etdp", etrecord_path="/path/to/etrecord.bin")
3839
3940
4041
print_data_tabular
4142
~~~~~~~~~~~~~~~~~~
4243

43-
.. autofunction:: sdk.inspector.inspector.Inspector.print_data_tabular
44+
.. automodule:: sdk.Inspector
45+
.. autofunction:: print_data_tabular
4446

4547
.. _example-usage-1:
4648

@@ -56,7 +58,8 @@ print_data_tabular
5658
find_total_for_module
5759
~~~~~~~~~~~~~~~~~~~~~
5860

59-
.. autofunction:: sdk.inspector.inspector.Inspector.find_total_for_module
61+
.. automodule:: sdk.Inspector
62+
.. autofunction:: find_total_for_module
6063

6164
.. _example-usage-2:
6265

@@ -74,7 +77,8 @@ find_total_for_module
7477
get_exported_program
7578
~~~~~~~~~~~~~~~~~~~~
7679

77-
.. autofunction:: sdk.inspector.inspector.Inspector.get_exported_program
80+
.. automodule:: sdk.Inspector
81+
.. autofunction:: get_exported_program
7882

7983
.. _example-usage-3:
8084

@@ -113,7 +117,8 @@ of an ``Inspector`` instance, for example:
113117
114118
inspector.event_blocks
115119
116-
.. autoclass:: sdk.inspector.inspector.EventBlock
120+
.. automodule:: sdk.inspector.inspector
121+
.. autoclass:: EventBlock
117122

118123
``Event`` Class
119124
~~~~~~~~~~~~~~~
@@ -127,7 +132,8 @@ Access ``Event`` instances through the ``events`` attribute of an
127132
for event in event_block.events:
128133
# Do something with each event
129134
130-
.. autoclass:: sdk.inspector.inspector.Event
135+
.. automodule:: sdk.inspector.inspector
136+
.. autoclass:: Event
131137

132138
**Example Usage:**
133139

0 commit comments

Comments
 (0)