Skip to main content
App version: 3.20250811

Run description

The description attribute is a way to manually annotate or comment on the run. You can display the description wherever you analyze your runs.

Aside from tags, the description is the only attribute that you can edit through the web app. Otherwise it behaves like any String attribute.

Add or edit description in the web app​

Note that any project member with the Contributor role can edit run descriptions.

From runs table​

  1. In the runs table, click inside the Description column.
  2. Enter the description text and press Tab or click outside of the cell.

From runs information menu​

  1. Open the run menu () and select Run information.
  2. In the Run information modal, enter your text in the Description box.
  3. To save the description, click .

From homepage​

  1. Go to the homepage.
  2. In the table, click inside the Description column.
  3. Enter the description text and press Tab or click outside of the cell.

Add a description via API​

Use the log_configs() method to log a string to the sys/description attribute:

from neptune_scale import Run


run = Run(...)
run.log_configs({"sys/description": "First experimentation with new v2.0 dataset"})

Edit description via API​

You can also modify a run's description using the Python client library:

  1. If the run is inactive, resume it first:

    from neptune_scale import Run


    run = Run(run_id="SomeExistingRunId")

  2. Overwrite the description attribute:

    run.log_configs({"sys/description": "Correction: First experimentation with new v3.0 dataset"})

Display description​

In the Neptune app, you can display the sys/description attribute in the following ways:

Run description displayed in a chart legend.