Skip to main content
App version: 3.4.11

System namespace

Python package: neptune-scale

When you create a Neptune run or experiment, the system namespace (sys) is automatically created in the Run object. It contains basic metadata about the run, lineage, and environment.

This section contains a complete reference of namespaces and attributes in the sys namespace.

diagnostics namespace

The diagnostics namespace helps you identify large runs and monitor growth in metadata.

note

This namespace is available only for runs created after the 3.4.11 release.

tracker_client

Attribute pathType
sys/diagnostics/tracker_clientString

The version of the Neptune Python client library that was installed when the run was created.

attributes namespace

The attributes namespace indicates the number of attributes per type as well as the total number of attributes.

file_ref_count

Attribute pathType
sys/diagnostics/attributes/file_ref_countInteger

The total number of File attributes.

float_count

Attribute pathType
sys/diagnostics/attributes/float_countInteger

The total number of Float attributes.

float_series_count

Attribute pathType
sys/diagnostics/attributes/float_series_countInteger

The total number of FloatSeries attributes.

int_count

Attribute pathType
sys/diagnostics/attributes/int_countInteger

The total number of Integer attributes.

string_count

Attribute pathType
sys/diagnostics/attributes/string_countInteger

The total number of String attributes.

string_series_count

Attribute pathType
sys/diagnostics/attributes/string_series_countInteger

The total number of StringSeries attributes.

string_set_count

Attribute pathType
sys/diagnostics/attributes/string_set_countInteger

The total number of StringSet attributes.

total_count

Attribute pathType
sys/diagnostics/attributes/total_countInteger

The total number of attributes in the run.

total_series_datapoints

Attribute pathType
sys/diagnostics/attributes/total_series_datapointsInteger

The combined number of data points logged to all of the run's series attributes. Each numerical, string, or file value in a series counts as a data point.

The following aren't counted:

experiment namespace

is_head

Attribute pathType
sys/experiment/is_headBoolean
  • If True: The run is the experiment's most recently updated run.

    The experiment is defined by the name attribute.

  • If False: The run is no longer the experiment head.


name

Attribute pathType
sys/experiment/nameString

The experiment that the run is part of.

To make the name easy to read in the app, ensure that it's at most 190 characters long.


running_time_seconds

Attribute pathType
sys/experiment/running_time_secondsFloat

Total running time of the constituent run objects in seconds. Running time counts as activity that involves logging metrics.

This number takes into account any additional resumes of runs.


forking namespace

The forking namespace contains information about the fork point and parent run.

depth

Attribute pathType
sys/forking/depthInteger

Levels of descent from the experiment's root run. For example:

Depth valueDescription
0The root run
1Child run of the root run
2Run that forks off the child run

parent

Attribute pathType
sys/forking/parentString

Identifier of the parent run. That is, the run that the current run was forked from.


requested_parent

This attribute can be used for troubleshooting purposes: If there's a requested parent but no actual parent run logged, there may be an issue in the training process, such as a race condition or unhandled error.


step

Attribute pathType
sys/forking/stepInteger

Step where the run forks off its parent run.


creation_time

Attribute pathType
sys/creation_timeDatetime

Creation time of the run. The value is determined by the creation_time argument of the Run constructor.


custom_run_id

Attribute pathType
sys/custom_run_idString

Custom identifier of the run. The value is determined by the run_id argument of the Run constructor.


description

Attribute pathType
sys/descriptionString

When you add a description via the web app or API, it's stored as a string in the description attribute.

To learn more, see Log metadata: Run description.


failed

This attribute is experimental and can be ignored.


family

This attribute can be ignored.


group_tags

Attribute pathType
sys/group_tagsStringSet

When you apply tags with add_tags(group_tags=True), the tags are stored under the attribute sys/group_tags.

To learn more, see Groups and Manage tags.


id

Attribute pathType
sys/idString

The auto-generated Neptune identifier, which consists of the project key and a counter.


modification_time

Attribute pathType
sys/modification_timeDatetime

When the run was last modified. This also takes into account actions via the web interface, such as managing tags.


monitoring_time

This attribute is deprecated and can be ignored.


name

Attribute pathType
sys/nameString

Name of the run. Same as the experiment name.

To make the name easy to read in the app, ensure that it's at most 190 characters long.


owner

Attribute pathType
sys/ownerString

The account which created the run.


ping_time

Attribute pathType
sys/ping_timeDatetime

When the Python client last interacted with the run.


relative_creation_time_ms

Timestamp of the last logged metric. When forking experiments, Neptune uses this timestamp as the indicator of when the parent run ended.


running_time_seconds

Attribute pathType
sys/running_time_secondsFloat

Total running time of the run object in seconds. Running time counts as activity that involves logging metrics.

This number takes into account any additional resumes of the run.


size

This attribute is experimental and can be ignored.


state

Attribute pathType
sys/stateObjectState

A run object can be in one of two states: active or inactive.

  • active means that at least one logging process is connected to the run.
  • The run state automatically changes to inactive once there's been no activity for 20 seconds, typically after the script ended or you called close().

Resuming an inactive run doesn't change its state to active if no metadata is added or modified.


tags

Attribute pathType
sys/tagsStringSet

Tags applied to the run, either via API or the web app.

To learn more, see Manage tags.


trashed

This attribute is experimental and can be ignored.