matflow.ValueSequence#

class matflow.ValueSequence(path, values, nesting_order=0, label=None, value_class_method=None)#

Bases: ValueSequence

Methods

from_file

from_geometric_space

from_json_like

from_linear_space

from_log_space

from_random_uniform

from_range

from_rectangle

param coord:

Which coordinate to use. Either 0, 1, or None, meaning each value will be

make_persistent

Save value to a persistent workflow.

to_dict

to_json_like

Attributes

app

input_path

input_type

is_sub_value

True if the values are for a sub part of the parameter.

labelled_type

normalised_inputs_path

Return the normalised path without the "inputs" prefix, if the sequence is an inputs sequence, else return None.

normalised_path

parameter

path_split

path_type

resource_scope

values

workflow

Parameters:
  • path (str) –

  • values (List[Any]) –

  • nesting_order (Optional[int]) –

  • label (Optional[str]) –

  • value_class_method (Optional[str]) –

app = App(name='MatFlow', version='0.3.0a129')#
classmethod from_file(path, file_path, nesting_order=0, label=None, **kwargs)#
classmethod from_geometric_space(path, start, stop, num, nesting_order=0, endpoint=True, label=None, **kwargs)#
classmethod from_json_like(json_like, shared_data=None)#
classmethod from_linear_space(path, start, stop, num, nesting_order=0, label=None, **kwargs)#
classmethod from_log_space(path, start, stop, num, nesting_order=0, base=10.0, endpoint=True, label=None, **kwargs)#
classmethod from_random_uniform(path, num, low=0.0, high=1.0, seed=None, nesting_order=0, label=None, **kwargs)#
classmethod from_range(path, start, stop, nesting_order=0, step=1, label=None, **kwargs)#
classmethod from_rectangle(path, start, stop, num, coord=None, include=None, nesting_order=0, label=None, **kwargs)#
Parameters:
  • coord (int | None) – Which coordinate to use. Either 0, 1, or None, meaning each value will be both coordinates.

  • include (list[str] | None) – If specified, include only the specified edges. Choose from “top”, “right”, “bottom”, “left”.

property input_path#
property input_type#
property is_sub_value#

True if the values are for a sub part of the parameter.

property labelled_type#
make_persistent(workflow, source)#

Save value to a persistent workflow.

Parameters:
Return type:

Tuple[str, List[int], bool]

property normalised_inputs_path#

Return the normalised path without the “inputs” prefix, if the sequence is an inputs sequence, else return None.

property normalised_path#
property parameter#
property path_split#
property path_type#
property resource_scope#
to_dict()#
to_json_like(dct=None, shared_data=None, exclude=None, path=None)#
property values#
property workflow#