OutputNodeState

Bases: object

__eq__(value)

Return self==value.

__ge__(value)

Return self>=value.

__getitem__(key)

Return self[key].

__gt__(value)

Return self>value.

__iter__()

Implement iter(self).

__le__(value)

Return self<=value.

__len__()

Return len(self).

__lt__(value)

Return self<value.

__ne__(value)

Return self!=value.

__repr__()

Return repr(self).

from_parquet(file_path, id_column='id')

Get OutputNodeState from Parquet

Parameters:

Name	Type	Description	Default
file_path	str	filepath from which to read OutputNodeState	required
id_column	str	column to which node IDs will be written. Defaults to "id".	'id'

Returns:

Type	Description
OutputNodeState

get(node, default=None)

Get value for node

Parameters:

Name	Type	Description	Default
node	NodeInput	the node	required
default	dict	the default value (dict of field name to value). Defaults to None.	None

Returns:

Type	Description
Optional[dict]	the value for the node or the default value

groups(cols)

Group by value

Parameters:

Name	Type	Description	Default
cols	list[str]	columns by which to group nodes	required

Returns:

Type	Description
list[tuple[dict, Nodes]]	The grouped nodes

items()

Iterate over items

Returns:

Type	Description
Iterator[Tuple[Node, Dict]]	Iterator over items

merge(other, index_merge_priority='left', default_column_merge_priority='left', column_merge_priority_map=None)

Merge with another OutputNodeState (produces new OutputNodeState)

Parameters:

Name	Type	Description	Default
other	OutputNodeState	OutputNodeState to merge with	required
index_merge_priority	str	"left" or "right" to take left or right index, "union" to union index sets. Defaults to "left".	'left'
default_column_merge_priority	str	"left" or "right" to prioritize left or right columns by default, "exclude" to exclude columns by default. Defaults to "left".	'left'
column_merge_priority_map	dict	map of column names (str) to merge priority ("left", "right", or "exclude"). Defaults to None.	None

Returns:

Type	Description
OutputNodeState

nodes()

Iterate over nodes

Returns:

Type	Description
Nodes	The nodes

sort_by(sort_params)

Get value for node

Parameters:

Name	Type	Description	Default
sort_params	Dict	Map of sort keys to sort option ('asc' or 'desc'). None defaults to 'asc'	required

Returns:

Type	Description
OutputNodeState	Sorted NodeState

to_parquet(file_path, id_column='id')

Convert OutputNodeState to Parquet

Parameters:

Name	Type	Description	Default
file_path	str	filepath to which OutputNodeState is written	required
id_column	str	column containing IDs of nodes. Defaults to "id".	'id'

Returns:

Type	Description
None

top_k(sort_params, k)

Get value for node

Parameters:

Name	Type	Description	Default
sort_params	Dict	Map of sort keys to sort option ('asc' or 'desc'). None defaults to 'asc'	required
k	int	Number of top entries to return.	required

Returns:

Type	Description
OutputNodeState	Sorted NodeState

values()

Iterate over values

Returns:

Type	Description
Iterator[Dict]	Iterator over values (dict of field name to value)