From 04857050af157363cc511d630afe321447b7bfe5 Mon Sep 17 00:00:00 2001 From: Alyssa Cote <46540273+AlyssaCote@users.noreply.github.com> Date: Wed, 14 Feb 2024 12:17:35 -0800 Subject: [PATCH] Update docs (#42) Update docs and changelog. --- README.md | 13 +++++++++++-- doc/changelog.rst | 15 +++++++++++++++ doc/overview.rst | 14 +++++++++----- 3 files changed, 35 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 6cae0e4..43bacc6 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,15 @@ SmartDashboard is an add-on to SmartSim that provides a dashboard to help users understand and monitor their SmartSim experiments in a visual way. Configuration, status, and logs are available for all launched entities within an experiment for easy inspection. +A ``Telemetry Monitor`` is a background process that is launched along with the experiment +that produces the data displayed by SmartDashboard. The ``Telemetry Monitor`` can be disabled by +adding ``export SMARTSIM_TELEMETRY_ENABLE=0`` as an environment variable. When disabled, SmartDashboard +will not display any data. To re-enable, set the ``SMARTSIM_TELEMETRY_ENABLE`` environment variable to ``1`` +with ``export SMARTSIM_TELEMETRY_ENABLE=1``. + +Experiment metadata is also stored in the ``.smartsim`` directory, a hidden folder for internal api use and used by the dashboard. +Deletion of the experiment folder will remove all experiment metadata. + ## Installation It's important to note that SmartDashboard only works while using SmartSim, so SmartSim will need to be installed as well. @@ -9,7 +18,7 @@ SmartSim installation docs can be found [here](https://www.craylabs.org/docs/ins ### User Install -Run `pip install git+https://github.com/CrayLabs/SmartDashboard.git` to install SmartDashboard without cloning the repository. +Run `pip install smartdashboard` to install SmartDashboard without cloning the repository. ### Developer Install @@ -88,6 +97,6 @@ The dashboard is also persistent, meaning that a user can still launch and use t Once the dashboard is launched, a browser will open to `http://localhost:`. SmartDashboard currently has two tabs on the left hand side. -`Experiment Overview:` This tab is where configuration information, statuses, and logs are located for each launched entity of the experiment. The `Experiment` section displays configuaration information for the overall experiment. In the `Applications` section, also known as SmartSim `Models`, select a launched application to see its status, what it was configured with, and its logs. The `Orchestrators` section also provides configuration and status information, as well as logs per shard for a selected orchestrator. Finally, in the `Ensembles` section, select an ensemble to see its status and configuration. Then select any of its members to see its status, configuration, and logs. +`Experiment Overview:` This tab is where configuration information, statuses, and logs are located for each launched entity of the experiment. The `Experiment` section displays configuration information for the overall experiment and its logs. In the `Applications` section, also known as SmartSim `Models`, select a launched application to see its status, what it was configured with, and its logs. The `Orchestrators` section also provides configuration and status information, as well as logs per shard for a selected orchestrator. Finally, in the `Ensembles` section, select an ensemble to see its status and configuration. Then select any of its members to see its status, configuration, and logs. `Help:` This tab links to SmartSim documentation and provides a SmartSim contact for support. diff --git a/doc/changelog.rst b/doc/changelog.rst index c8143ec..3cd086d 100644 --- a/doc/changelog.rst +++ b/doc/changelog.rst @@ -1,6 +1,21 @@ Changelog ========= +0.0.3 +----- + +Released on 15 February 2024 + +Description + +- Added defined schemas for entity objects. (SmartDashboard-PR31_) +- Added experiment level logs to the dashboard. (SmartDashboard-PR37_) + +.. _SmartDashboard-PR31: https://github.com/CrayLabs/SmartDashboard/pull/31 +.. _SmartDashboard-PR37: https://github.com/CrayLabs/SmartDashboard/pull/37 + + + 0.0.2 ----- diff --git a/doc/overview.rst b/doc/overview.rst index e24367d..82154b1 100644 --- a/doc/overview.rst +++ b/doc/overview.rst @@ -7,9 +7,13 @@ SmartDashboard and monitor their SmartSim experiments in a visual way. Configuration, status, and logs are available for all launched entities within an experiment for easy inspection. -A ``Telemetry Monitor`` is a new background process that is launched along with the experiment -that helps ``SmartDashboard`` properly display data. Experiment metadata is also stored in -the ``.smartsim`` directory, a hidden folder for internal api use and used by the dashboard. +A ``Telemetry Monitor`` is a background process that is launched along with the experiment +that produces the data displayed by SmartDashboard. The ``Telemetry Monitor`` can be disabled by +adding ``export SMARTSIM_TELEMETRY_ENABLE=0`` as an environment variable. When disabled, SmartDashboard +will not display any data. To re-enable, set the ``SMARTSIM_TELEMETRY_ENABLE`` environment variable to ``1`` +with ``export SMARTSIM_TELEMETRY_ENABLE=1``. + +Experiment metadata is also stored in the ``.smartsim`` directory, a hidden folder for internal api use and used by the dashboard. Deletion of the experiment folder will remove all experiment metadata. @@ -24,7 +28,7 @@ found `here User Install: -Run ``pip install git+https://github.com/CrayLabs/SmartDashboard.git`` to install +Run ``pip install smartdashboard`` to install SmartDashboard without cloning the repository. Developer Install: @@ -124,7 +128,7 @@ Once displayed in the browser, SmartDashboard currently has two tabs on the left ``Experiment Overview:`` This tab is where configuration information, statuses, and logs are located for each launched entity of the experiment. The ``Experiment`` -section displays configuaration information for the overall experiment. In the ``Applications`` +section displays configuration information for the overall experiment and its logs. In the ``Applications`` section, also known as SmartSim ``Models``, select a launched application to see its status, what it was configured with, and its logs. The ``Orchestrators`` section also provides configuration and status information, as well as logs per shard for a selected orchestrator.