From 9042b7ba70207cefc7f13796e62d0c385662f03c Mon Sep 17 00:00:00 2001 From: awslucashendren Date: Thu, 8 Jan 2026 12:58:52 -0800 Subject: [PATCH 1/2] Update get-started.rst Update the document to use neuron-explorer and leave a note about neuron-profiler --- tools/neuron-explorer/get-started.rst | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/tools/neuron-explorer/get-started.rst b/tools/neuron-explorer/get-started.rst index 4fd98625..571b899e 100644 --- a/tools/neuron-explorer/get-started.rst +++ b/tools/neuron-explorer/get-started.rst @@ -76,8 +76,7 @@ Start the Neuron Explorer web servers using the following command: .. code-block:: bash - neuron-profile view -v 2 --data-path ./parquet_files --ui-mode latest - + neuron-explorer view -v 2 --data-path ./parquet_files --ui-mode latest This command starts: @@ -89,6 +88,12 @@ This command starts: You'll see terminal logs confirming that both the UI and API servers are running. +.. note:: + +**Command Update:** + +The command has been renamed from ``neuron-profiler`` to ``neuron-explorer``. If you're using an older version of the library, use ``neuron-profiler view`` instead. + 4. Set up SSH tunneling ^^^^^^^^^^^^^^^^^^^^^^^^ @@ -147,5 +152,5 @@ If you encounter an error or other issue while working through this task, here a * **Neuron Explorer UI doesn't load**: Check that your SSH tunnel is configured correctly. Make sure ports 3001 and 3002 are forwarded using the ``-L`` flags in your SSH command, and verify the EC2 instance is running. * **No profiling data displayed**: Double-check that the directory passed to ``--data-path`` contains valid .parquet profiling files generated by a prior Neuron profiling run. -* **neuron-profile command not found**: Ensure that Neuron SDK is installed. Please ensure that you have launched your instance with Neuron DLAMI or you have set up your instance based on the instructions mentioned here. +* **neuron-explorer command not found**: Ensure that Neuron SDK is installed. Please ensure that you have launched your instance with Neuron DLAMI or you have set up your instance based on the instructions mentioned here. * **Connection refused on port 3001 or 3002**: Confirm that your EC2 security group allows outbound traffic and that the SSH tunnel was created from your local machine, not from inside the instance. From d637c243f12bb1767bc011dc09915cb8dbcba8b3 Mon Sep 17 00:00:00 2001 From: awslucashendren Date: Thu, 8 Jan 2026 13:19:27 -0800 Subject: [PATCH 2/2] Update get-started.rst by removing ui-mode flag documentation --- tools/neuron-explorer/get-started.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tools/neuron-explorer/get-started.rst b/tools/neuron-explorer/get-started.rst index 571b899e..215197e3 100644 --- a/tools/neuron-explorer/get-started.rst +++ b/tools/neuron-explorer/get-started.rst @@ -76,7 +76,7 @@ Start the Neuron Explorer web servers using the following command: .. code-block:: bash - neuron-explorer view -v 2 --data-path ./parquet_files --ui-mode latest + neuron-explorer view -v 2 --data-path ./parquet_files This command starts: