Add a description

A description adds context to the run. It's a way to attach a free-form note and display it wherever you analyze your runs.

Adding a description to a new run

Using the log_configs() method, 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"})

tip

To display descriptions in the app, add the sys/description attribute to the runs table columns.

Manage description in the web app

To add or modify a description:

1. In the runs table, add sys/description as a column.
2. Click inside the Description column.
3. Enter the description text and press Tab or click outside of the cell.

Alternatively, you can modify the description in the run 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 .

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", resume=True, ...)

2. Overwrite the description attribute:

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