New URL for the Inspector page (#5810)

Olivia-liu · facebook-github-bot · commit 835bd34d40b2 · 2024-10-02T18:09:22.000-07:00
Summary: Pull Request resolved: #5810 This diff is to rename the "sdk-inspector" documentation page to just "model-inspector". Old URL: https://pytorch.org/executorch/main/sdk-inspector.html New URL: https://pytorch.org/executorch/main/model-inspector.html Design doc: https://docs.google.com/document/d/1l6DYTq9Kq6VrPohruRFP-qScZDj01W_g4zlKyvqKGF4/edit?usp=sharing Reviewed By: dbort Differential Revision: D63741034 fbshipit-source-id: 57ce5769790d4da431333c781dec2fdbb8ebdb80
diff --git a/docs/source/build-run-coreml.md b/docs/source/build-run-coreml.md
@@ -108,7 +108,7 @@ cd executorch
 ./coreml_executor_runner --model_path mv3_coreml_all.pte --profile_model --etdump_path etdump.etdp
 ```
 
-4. Create an instance of the [Inspector API](./sdk-inspector.rst) by passing in the [ETDump](./etdump.md) you have sourced from the runtime along with the optionally generated [ETRecord](./etrecord.rst) from step 1 or execute the following command in your terminal to display the profiling data table.
+4. Create an instance of the [Inspector API](./model-inspector.rst) by passing in the [ETDump](./etdump.md) you have sourced from the runtime along with the optionally generated [ETRecord](./etrecord.rst) from step 1 or execute the following command in your terminal to display the profiling data table.
 ```bash
 python examples/apple/coreml/scripts/inspector_cli.py --etdump_path etdump.etdp --etrecord_path mv3_coreml.bin
 ```
diff --git a/docs/source/delegate-debugging.md b/docs/source/delegate-debugging.md
@@ -127,7 +127,7 @@ A demo of the runtime code can be found [here](https://github.com/pytorch/execut
 
 ## Surfacing custom metadata from delegate events
 
-As seen in the runtime logging API's above, users can log an array of bytes along with their delegate profiling event. We make this data available for users in post processing via the [Inspector API](./sdk-inspector.rst).
+As seen in the runtime logging API's above, users can log an array of bytes along with their delegate profiling event. We make this data available for users in post processing via the [Inspector API](./model-inspector.rst).
 
 Users can pass a metadata parser when creating an instance of the Inspector. The parser is a callable that deserializes the data and returns a list of strings or a dictionary containing key-value pairs. The deserialized data is then added back to the corresponding event in the event block for user consumption. Here's an example of how to write this parser:
 
diff --git a/docs/source/devtools-overview.md b/docs/source/devtools-overview.md
@@ -42,4 +42,4 @@ More details are available in the [ETDump documentation](etdump.md) on how to ge
 ### Inspector APIs
 The Inspector Python APIs are the main user enrty point into the Developer Tools. They join the data sourced from ETDump and ETRecord to give users access to all the performance and debug data sourced from the runtime along with linkage back to eager model source code and module hierarchy in an easy to use API.
 
-More details are available in the [Inspector API documentation](sdk-inspector.rst) on how to use the Inspector APIs.
+More details are available in the [Inspector API documentation](model-inspector.rst) on how to use the Inspector APIs.
diff --git a/docs/source/etdump.md b/docs/source/etdump.md
@@ -41,4 +41,4 @@ target_compile_options(portable_ops_lib INTERFACE -DET_EVENT_TRACER_ENABLED)
 ```
 ## Using an ETDump
 
-Pass this ETDump into the [Inspector API](./sdk-inspector.rst) to access this data and do post-run analysis.
+Pass this ETDump into the [Inspector API](./model-inspector.rst) to access this data and do post-run analysis.
diff --git a/docs/source/etrecord.rst b/docs/source/etrecord.rst
@@ -18,7 +18,7 @@ them to debug and visualize their model.
 * Delegate debug handle maps
 
 The ``ETRecord`` object itself is intended to be opaque to users and they should not access any components inside it directly.
-It should be provided to the `Inspector API <sdk-inspector.html>`__ to link back performance and debug data sourced from the runtime back to the Python source code.
+It should be provided to the `Inspector API <model-inspector.html>`__ to link back performance and debug data sourced from the runtime back to the Python source code.
 
 Generating an ``ETRecord``
 --------------------------
@@ -37,4 +37,4 @@ they are interested in working with via our tooling.
 Using an ``ETRecord``
 ---------------------
 
-Pass the ``ETRecord`` as an optional argument into the `Inspector API <sdk-inspector.html>`__ to access this data and  do post-run analysis.
+Pass the ``ETRecord`` as an optional argument into the `Inspector API <model-inspector.html>`__ to access this data and  do post-run analysis.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -206,7 +206,7 @@ Topics in this section will help you get started with ExecuTorch.
    etdump
    sdk-profiling
    model-debugging
-   sdk-inspector
+   model-inspector
    memory-planning-inspection
    delegate-debugging
    devtools-tutorial
diff --git a/docs/source/llm/getting-started.md b/docs/source/llm/getting-started.md
@@ -843,7 +843,7 @@ This prints the performance data in a tabular format in “inspector_out.txt”,
 ![](../_static/img/llm_manual_print_data_tabular.png)
 <a href="../_static/img/llm_manual_print_data_tabular.png" target="_blank">View in full size</a>
 
-To learn more about the Inspector and the rich functionality it provides, see the [Inspector API Reference](../sdk-inspector.md).
+To learn more about the Inspector and the rich functionality it provides, see the [Inspector API Reference](../model-inspector.md).
 
 ## Custom Kernels
 With the ExecuTorch custom operator APIs, custom operator and kernel authors can easily bring in their kernel into PyTorch/ExecuTorch.
diff --git a/docs/source/model-debugging.md b/docs/source/model-debugging.md
@@ -35,7 +35,7 @@ For a real example reflecting the steps below, please refer to [example_runner.c
 
 
 ### Accessing the debug outputs post run using the Inspector API's
-Once a model has been run, using the generated ETDump and debug buffers, users can leverage the [Inspector API's](./sdk-inspector.rst) to inspect these debug outputs.
+Once a model has been run, using the generated ETDump and debug buffers, users can leverage the [Inspector API's](./model-inspector.rst) to inspect these debug outputs.
 
 ```python
 from executorch.devtools import Inspector
diff --git a/docs/source/model-inspector.rst b/docs/source/model-inspector.rst
@@ -0,0 +1,159 @@
+Inspector APIs
+==============
+
+Overview
+--------
+
+The Inspector APIs provide a convenient interface for analyzing the
+contents of `ETRecord <etrecord.html>`__ and
+`ETDump <etdump.html>`__, helping developers get insights about model
+architecture and performance statistics. It’s built on top of the `EventBlock Class <#eventblock-class>`__ data structure,
+which organizes a group of `Event <#event-class>`__\ s for easy access to details of profiling events.
+
+There are multiple ways in which users can interact with the Inspector
+APIs:
+
+* By using `public methods <#inspector-methods>`__ provided by the ``Inspector`` class.
+* By accessing the `public attributes <#inspector-attributes>`__ of the ``Inspector``, ``EventBlock``, and ``Event`` classes.
+* By using a `CLI <#cli>`__ tool for basic functionalities.
+
+Please refer to the `e2e use case doc <tutorials/devtools-integration-tutorial.html>`__ get an understanding of how to use these in a real world example.
+
+
+Inspector Methods
+-----------------
+
+Constructor
+~~~~~~~~~~~
+
+.. autofunction:: executorch.devtools.Inspector.__init__
+
+**Example Usage:**
+
+.. code:: python
+
+    from executorch.devtools import Inspector
+
+    inspector = Inspector(etdump_path="/path/to/etdump.etdp", etrecord="/path/to/etrecord.bin")
+
+to_dataframe
+~~~~~~~~~~~~~~~~
+
+.. autofunction:: executorch.devtools.Inspector.to_dataframe
+
+
+print_data_tabular
+~~~~~~~~~~~~~~~~~~
+
+.. autofunction:: executorch.devtools.Inspector.print_data_tabular
+
+.. _example-usage-1:
+
+**Example Usage:**
+
+.. code:: python
+
+    inspector.print_data_tabular()
+
+.. image:: _static/img/print_data_tabular.png
+Note that the unit of delegate profiling events is "cycles". We're working on providing a way to set different units in the future.
+
+
+find_total_for_module
+~~~~~~~~~~~~~~~~~~~~~
+
+.. autofunction:: executorch.devtools.Inspector.find_total_for_module
+
+.. _example-usage-2:
+
+**Example Usage:**
+
+.. code:: python
+
+    print(inspector.find_total_for_module("L__self___conv_layer"))
+
+::
+
+    0.002
+
+
+get_exported_program
+~~~~~~~~~~~~~~~~~~~~
+
+.. autofunction:: executorch.devtools.Inspector.get_exported_program
+
+.. _example-usage-3:
+
+**Example Usage:**
+
+.. code:: python
+
+    print(inspector.get_exported_program())
+
+::
+
+    ExportedProgram:
+        class GraphModule(torch.nn.Module):
+            def forward(self, arg0_1: f32[4, 3, 64, 64]):
+                # No stacktrace found for following nodes
+                _param_constant0 = self._param_constant0
+                _param_constant1 = self._param_constant1
+
+                ### ... Omit part of the program for documentation readability ... ###
+
+    Graph signature: ExportGraphSignature(parameters=[], buffers=[], user_inputs=['arg0_1'], user_outputs=['aten_tan_default'], inputs_to_parameters={}, inputs_to_buffers={}, buffers_to_mutate={}, backward_signature=None, assertion_dep_token=None)
+    Range constraints: {}
+    Equality constraints: []
+
+
+Inspector Attributes
+--------------------
+
+``EventBlock`` Class
+~~~~~~~~~~~~~~~~~~~~
+
+Access ``EventBlock`` instances through the ``event_blocks`` attribute
+of an ``Inspector`` instance, for example:
+
+.. code:: python
+
+    inspector.event_blocks
+
+.. autoclass:: executorch.devtools.inspector.EventBlock
+
+``Event`` Class
+~~~~~~~~~~~~~~~
+
+Access ``Event`` instances through the ``events`` attribute of an
+``EventBlock`` instance.
+
+.. autoclass:: executorch.devtools.inspector.Event
+
+**Example Usage:**
+
+.. code:: python
+
+    for event_block in inspector.event_blocks:
+        for event in event_block.events:
+            if event.name == "Method::execute":
+                print(event.perf_data.raw)
+
+::
+
+    [175.748, 78.678, 70.429, 122.006, 97.495, 67.603, 70.2, 90.139, 66.344, 64.575, 134.135, 93.85, 74.593, 83.929, 75.859, 73.909, 66.461, 72.102, 84.142, 77.774, 70.038, 80.246, 59.134, 68.496, 67.496, 100.491, 81.162, 74.53, 70.709, 77.112, 59.775, 79.674, 67.54, 79.52, 66.753, 70.425, 71.703, 81.373, 72.306, 72.404, 94.497, 77.588, 79.835, 68.597, 71.237, 88.528, 71.884, 74.047, 81.513, 76.116]
+
+
+CLI
+---
+
+Execute the following command in your terminal to display the data
+table. This command produces the identical table output as calling the
+`print_data_tabular <#print-data-tabular>`__ mentioned earlier:
+
+.. code:: bash
+
+    python3 -m devtools.inspector.inspector_cli --etdump_path <path_to_etdump> --etrecord_path <path_to_etrecord>
+
+Note that the `etrecord_path` argument is optional.
+
+We plan to extend the capabilities of the CLI in the future.
diff --git a/docs/source/sdk-inspector.rst b/docs/source/sdk-inspector.rst
@@ -1,159 +1,4 @@
 Inspector APIs
 ==============
 
-Overview
---------
-
-The Inspector APIs provide a convenient interface for analyzing the
-contents of `ETRecord <etrecord.html>`__ and
-`ETDump <etdump.html>`__, helping developers get insights about model
-architecture and performance statistics. It’s built on top of the `EventBlock Class <#eventblock-class>`__ data structure,
-which organizes a group of `Event <#event-class>`__\ s for easy access to details of profiling events.
-
-There are multiple ways in which users can interact with the Inspector
-APIs:
-
-* By using `public methods <#inspector-methods>`__ provided by the ``Inspector`` class.
-* By accessing the `public attributes <#inspector-attributes>`__ of the ``Inspector``, ``EventBlock``, and ``Event`` classes.
-* By using a `CLI <#cli>`__ tool for basic functionalities.
-
-Please refer to the `e2e use case doc <tutorials/devtools-integration-tutorial.html>`__ get an understanding of how to use these in a real world example.
-
-
-Inspector Methods
------------------
-
-Constructor
-~~~~~~~~~~~
-
-.. autofunction:: executorch.devtools.Inspector.__init__
-
-**Example Usage:**
-
-.. code:: python
-
-    from executorch.devtools import Inspector
-
-    inspector = Inspector(etdump_path="/path/to/etdump.etdp", etrecord="/path/to/etrecord.bin")
-
-to_dataframe
-~~~~~~~~~~~~~~~~
-
-.. autofunction:: executorch.devtools.Inspector.to_dataframe
-
-
-print_data_tabular
-~~~~~~~~~~~~~~~~~~
-
-.. autofunction:: executorch.devtools.Inspector.print_data_tabular
-
-.. _example-usage-1:
-
-**Example Usage:**
-
-.. code:: python
-
-    inspector.print_data_tabular()
-
-.. image:: _static/img/print_data_tabular.png
-Note that the unit of delegate profiling events is "cycles". We're working on providing a way to set different units in the future.
-
-
-find_total_for_module
-~~~~~~~~~~~~~~~~~~~~~
-
-.. autofunction:: executorch.devtools.Inspector.find_total_for_module
-
-.. _example-usage-2:
-
-**Example Usage:**
-
-.. code:: python
-
-    print(inspector.find_total_for_module("L__self___conv_layer"))
-
-::
-
-    0.002
-
-
-get_exported_program
-~~~~~~~~~~~~~~~~~~~~
-
-.. autofunction:: executorch.devtools.Inspector.get_exported_program
-
-.. _example-usage-3:
-
-**Example Usage:**
-
-.. code:: python
-
-    print(inspector.get_exported_program())
-
-::
-
-    ExportedProgram:
-        class GraphModule(torch.nn.Module):
-            def forward(self, arg0_1: f32[4, 3, 64, 64]):
-                # No stacktrace found for following nodes
-                _param_constant0 = self._param_constant0
-                _param_constant1 = self._param_constant1
-
-                ### ... Omit part of the program for documentation readability ... ###
-
-    Graph signature: ExportGraphSignature(parameters=[], buffers=[], user_inputs=['arg0_1'], user_outputs=['aten_tan_default'], inputs_to_parameters={}, inputs_to_buffers={}, buffers_to_mutate={}, backward_signature=None, assertion_dep_token=None)
-    Range constraints: {}
-    Equality constraints: []
-
-
-Inspector Attributes
---------------------
-
-``EventBlock`` Class
-~~~~~~~~~~~~~~~~~~~~
-
-Access ``EventBlock`` instances through the ``event_blocks`` attribute
-of an ``Inspector`` instance, for example:
-
-.. code:: python
-
-    inspector.event_blocks
-
-.. autoclass:: executorch.devtools.inspector.EventBlock
-
-``Event`` Class
-~~~~~~~~~~~~~~~
-
-Access ``Event`` instances through the ``events`` attribute of an
-``EventBlock`` instance.
-
-.. autoclass:: executorch.devtools.inspector.Event
-
-**Example Usage:**
-
-.. code:: python
-
-    for event_block in inspector.event_blocks:
-        for event in event_block.events:
-            if event.name == "Method::execute":
-                print(event.perf_data.raw)
-
-::
-
-    [175.748, 78.678, 70.429, 122.006, 97.495, 67.603, 70.2, 90.139, 66.344, 64.575, 134.135, 93.85, 74.593, 83.929, 75.859, 73.909, 66.461, 72.102, 84.142, 77.774, 70.038, 80.246, 59.134, 68.496, 67.496, 100.491, 81.162, 74.53, 70.709, 77.112, 59.775, 79.674, 67.54, 79.52, 66.753, 70.425, 71.703, 81.373, 72.306, 72.404, 94.497, 77.588, 79.835, 68.597, 71.237, 88.528, 71.884, 74.047, 81.513, 76.116]
-
-
-CLI
----
-
-Execute the following command in your terminal to display the data
-table. This command produces the identical table output as calling the
-`print_data_tabular <#print-data-tabular>`__ mentioned earlier:
-
-.. code:: bash
-
-    python3 -m devtools.inspector.inspector_cli --etdump_path <path_to_etdump> --etrecord_path <path_to_etrecord>
-
-Note that the `etrecord_path` argument is optional.
-
-We plan to extend the capabilities of the CLI in the future.
+Please update your link to <https://pytorch.org/executorch/main/model-inspector.html>. This URL will be deleted after v0.4.0.
diff --git a/docs/source/sdk-profiling.md b/docs/source/sdk-profiling.md
diff --git a/docs/source/tutorials_source/devtools-integration-tutorial.py b/docs/source/tutorials_source/devtools-integration-tutorial.py
