Skip to content

Update get-started.rst for neuron-explorer #1267

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

Open
awslucashendren wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update get-started.rst for neuron-explorer #1267

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9042b7b
Update get-started.rst
awslucashendren Jan 8, 2026
d637c24
Update get-started.rst by removing ui-mode flag documentation
awslucashendren Jan 8, 2026
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
11 changes: 8 additions & 3 deletions tools/neuron-explorer/get-started.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

This command starts:

Expand All @@ -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
^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down Expand Up @@ -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.