secretflow.component#

secretflow.component.component#

Classes:

IoType(value)

An enumeration.

TableColParam(name, desc[, ...])

Component(name[, domain, version, desc])

class secretflow.component.component.IoType(value)[源代码]#

基类:Enum

An enumeration.

Attributes:

INPUT

OUTPUT

INPUT = 1#
OUTPUT = 2#
class secretflow.component.component.TableColParam(name: str, desc: str, col_list_min_cnt: int = None, col_list_max_cnt: int = None)[源代码]#

基类:object

Attributes:

name

desc

col_list_min_cnt

col_list_max_cnt

Methods:

__init__(name, desc[, col_list_min_cnt, ...])

name: str#
desc: str#
col_list_min_cnt: int = None#
col_list_max_cnt: int = None#
__init__(name: str, desc: str, col_list_min_cnt: Optional[int] = None, col_list_max_cnt: Optional[int] = None) None#
class secretflow.component.component.Component(name: str, domain='', version='', desc='')[源代码]#

基类:object

Methods:

__init__(name[, domain, version, desc])

float_param(name, desc, is_list, is_optional)

int_param(name, desc, is_list, is_optional)

str_param(name, desc, is_list, is_optional)

bool_param(name, desc, is_list, is_optional)

table_io(io_type, name, desc, types[, ...])

model_io(io_type, name, desc, types)

eval_fn(f)

definition()

eval(instance, secretflow_cluster_config)

__init__(name: str, domain='', version='', desc='') None[源代码]#
float_param(name: str, desc: str, is_list: bool, is_optional: bool, default_value: Optional[Union[List[float], float]] = None, allowed_values: Optional[List[float]] = None, lower_bound: Optional[float] = None, upper_bound: Optional[float] = None, lower_bound_inclusive: bool = False, upper_bound_inclusive: bool = False, list_min_lenth_inclusive: Optional[int] = None, list_max_length_inclusive: Optional[int] = None)[源代码]#
int_param(name: str, desc: str, is_list: bool, is_optional: bool, default_value: Optional[Union[List[int], int]] = None, allowed_values: Optional[List[int]] = None, lower_bound: Optional[int] = None, upper_bound: Optional[int] = None, lower_bound_inclusive: bool = False, upper_bound_inclusive: bool = False, list_min_lenth_inclusive: Optional[int] = None, list_max_length_inclusive: Optional[int] = None)[源代码]#
str_param(name: str, desc: str, is_list: bool, is_optional: bool, default_value: Optional[Union[str, List[str]]] = None, allowed_values: Optional[List[str]] = None, list_min_lenth_inclusive: Optional[int] = None, list_max_length_inclusive: Optional[int] = None)[源代码]#
bool_param(name: str, desc: str, is_list: bool, is_optional: bool, default_value: Optional[Union[List[bool], bool]] = None, list_min_lenth_inclusive: Optional[int] = None, list_max_length_inclusive: Optional[int] = None)[源代码]#
table_io(io_type: IoType, name: str, desc: str, types: List[TableType], col_params: List[TableColParam] = None)[源代码]#
model_io(io_type: IoType, name: str, desc: str, types: List[str])[源代码]#
eval_fn(f)[源代码]#
definition()[源代码]#
eval(instance: NodeDef, secretflow_cluster_config)[源代码]#

secretflow.component.entry#

Functions:

gen_key(domain, name, version)

generate_comp_list()

eval(instance, secretflow_cluster_config)

secretflow.component.entry.gen_key(domain: str, name: str, version: str) str[源代码]#
secretflow.component.entry.generate_comp_list()[源代码]#
secretflow.component.entry.eval(instance: NodeDef, secretflow_cluster_config)[源代码]#

secretflow.component.node_reader#

Functions:

check_allowed_values(value, definition)

check_lower_bound(value, definition)

check_upper_bound(value, definition)

get_value(value, definition)

Classes:

NodeReader(instance, definition)

secretflow.component.node_reader.check_allowed_values(value: AtomicParameter, definition: AtomicParameterDef)[源代码]#
secretflow.component.node_reader.check_lower_bound(value: AtomicParameter, definition: AtomicParameterDef)[源代码]#
secretflow.component.node_reader.check_upper_bound(value: AtomicParameter, definition: AtomicParameterDef)[源代码]#
secretflow.component.node_reader.get_value(value: AtomicParameter, definition: AtomicParameterDef)[源代码]#
class secretflow.component.node_reader.NodeReader(instance: NodeDef, definition: ComponentDef)[源代码]#

基类:object

Methods:

__init__(instance, definition)

get_param(prefixes, name)

get_input(name)

get_output(name)

__init__(instance: NodeDef, definition: ComponentDef) None[源代码]#
get_param(prefixes: str, name: str)[源代码]#
get_input(name: str)[源代码]#
get_output(name: str)[源代码]#