Skip to main content
App version: 3.20250825

fetch_series()

Fetches a table of series values per step, for non-numerical series attributes.

To narrow the results, define filters for experiments to search or attributes to include.

Supported types:

Parameters​

project
str
optional
default: None

Path of the Neptune project, as WorkspaceName/ProjectName.

If not provided, the NEPTUNE_PROJECT environment variable is used.

experiments
str | list[str] | Filter
required

Filter specifying which experiments to include.

  • If a string is provided, it's treated as a regex pattern that the experiment names must match.
  • If a list of strings is provided, it's treated as exact experiment names to match.
  • To provide a more complex condition on an arbitrary attribute value, pass a Filter object.
attributes
str | list[str] | AttributeFilter
required

Filter specifying which attributes to include.

  • If a string is provided, it's treated as a regex pattern that the attribute names must match.
  • If a list of strings is provided, it's treated as exact attribute names to match.
  • To provide a more complex condition, pass an AttributeFilter object.
include_time
"absolute"
optional
default: None

Whether to include absolute timestamp. If set, each metric column has an additional sub-column with requested timestamp values.

step_range
Tuple[float | None, float | None]
optional
default: (None, None)

Tuple specifying the range of steps to include.

If None is used, it represents an open interval.

lineage_to_the_root
bool
optional
default: True

If True, includes all points from the complete experiment history.

If False, only includes points from the selected experiment.

tail_limit
int
optional
default: None

From the tail end of each series, how many points to include at most.

Example​

Fetch custom string series of two specific experiments from step 1000 onward:

import neptune_query as nq


nq.fetch_series(
    experiments=["seagull-week1", "seagull-week2"],
    attributes=r"^messages/",
    step_range=(1000.0, None),
)

Fetch from runs​

To target individual runs by ID instead of experiment name, import the runs API:

import neptune_query.runs as nq_runs

Then call the corresponding querying method and replace the experiments parameter with runs:

nq_runs.fetch_series(
    runs=["prompt-wolf-20250605132116671-2g2r1"],  # run ID
    attributes=r"^messages/",
    step_range=(1000.0, None),
)