Skip to content

Commit e12cddf

Browse files
authored
fix references to experiments in runs.py (#16)
1 parent 2a6f059 commit e12cddf

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

src/neptune_query/runs.py

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -111,8 +111,8 @@ def list_attributes(
111111
project: Path of the Neptune project, as `WorkspaceName/ProjectName`.
112112
If not provided, the NEPTUNE_PROJECT environment variable is used.
113113
runs: Filter specifying which runs to include.
114-
If a string is provided, it's treated as a regex pattern that the names must match.
115-
If a list of strings is provided, it's treated as exact experiment names to match.
114+
If a string is provided, it's treated as a regex pattern that the run IDs must match.
115+
If a list of strings is provided, it's treated as exact run IDs to match.
116116
To provide a more complex condition on an arbitrary attribute value, pass a Filter object.
117117
attributes: Filter specifying which attributes to include.
118118
If a string is provided, it's treated as a regex pattern that the attribute names must match.
@@ -183,8 +183,8 @@ def fetch_metrics(
183183
include_time: To include absolute timestamps, pass `"absolute"` as the value.
184184
If set, each metric column has an additional sub-column with requested timestamp values.
185185
step_range: Tuple specifying the range of steps to include. Can represent an open interval.
186-
lineage_to_the_root: If True (default), includes all points from the complete experiment history.
187-
If False, only includes points from the most recent experiment in the lineage.
186+
lineage_to_the_root: If True (default), includes all points from the complete run history.
187+
If False, only includes points from the most recent run in the lineage.
188188
tail_limit: From the tail end of each series, how many points to include at most.
189189
type_suffix_in_column_names: If True, columns of the returned DataFrame
190190
are suffixed with ":<type>", e.g. "attribute1:float_series", "attribute1:string".
@@ -324,8 +324,8 @@ def fetch_series(
324324
include_time: To include absolute timestamps, pass `"absolute"` as the value.
325325
If set, each metric column has an additional sub-column with requested timestamp values.
326326
step_range: Tuple specifying the range of steps to include. Can represent an open interval.
327-
lineage_to_the_root: If True (default), includes all values from the complete experiment history.
328-
If False, only includes values from the most recent experiment in the lineage.
327+
lineage_to_the_root: If True (default), includes all values from the complete run history.
328+
If False, only includes values from the most recent run in the lineage.
329329
tail_limit: From the tail end of each series, how many values to include at most.
330330
331331
Example:

0 commit comments

Comments
 (0)