# Copyright (c) 2017, System Engineering Software Society
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
# * Redistributions of source code must retain the above copyright
# notice, this list of conditions and the following disclaimer.
# * Redistributions in binary form must reproduce the above copyright
# notice, this list of conditions and the following disclaimer in the
# documentation and/or other materials provided with the distribution.
# * Neither the name of the System Engineering Software Society nor the
# names of its contributors may be used to endorse or promote products
# derived from this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
# ARE DISCLAIMED.
# IN NO EVENT SHALL SYSTEM ENGINEERING SOFTWARE SOCIETY BE LIABLE FOR ANY
# DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
# (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
# LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
# ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
# SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
from __future__ import (print_function, division, unicode_literals,
absolute_import)
import numpy as np
import sklearn
from sympathy.api import node
from sympathy.api.nodeconfig import Port
from sympathy.api.nodeconfig import Ports
from sympathy.api.nodeconfig import Tag
from sympathy.api.nodeconfig import Tags
from sympathy.api.exceptions import SyDataError
from sympathy.api.exceptions import sywarn
from sylib.machinelearning.model import ModelPort
from sylib.machinelearning.abstract_nodes import SyML_abstract
[docs]class SetParameters(node.Node):
name = 'Set Parameters'
author = 'Mathias Broxvall'
copyright = '(C) 2017 System Engineering Software Society'
version = '0.1'
icon = 'set_params.svg'
description = """Sets the model hyper parameters based on table data"""
nodeid = 'org.sysess.sympathy.machinelearning.set_parameters'
tags = Tags(Tag.MachineLearning.HyperParameters)
inputs = Ports([ModelPort('Input model', 'in-model'),
Port.Table('Parameters', name='parameters')])
outputs = Ports([ModelPort('Output model', 'out-model')])
parameters = node.parameters()
parameters.set_boolean(
'copy_through', value=True, label='Copy model parameters',
description=(
'Keeps the model parameters that are not overwritten by the input'
'table. Otherwise default values are used.'))
__doc__ = SyML_abstract.generate_docstring2(
description, parameters, inputs, outputs)
def execute(self, node_context):
in_model = node_context.input['in-model']
in_tbl = node_context.input['parameters']
out_model = node_context.output['out-model']
copy_through = node_context.parameters['copy_through'].value
out_model.source(in_model)
out_model.load()
skl = out_model.get_skl()
desc = out_model.get_desc()
if skl is None or not isinstance(skl, sklearn.base.BaseEstimator):
raise SyDataError("Invalid model type in input data")
if copy_through:
skl_params = skl.get_params()
else:
skl_params = {}
for name in in_tbl.column_names():
if name not in desc.parameters:
sywarn('Table column {0} is not a hyper parameter '
'for this model type'.format(name))
info = desc.parameters[name]
skl_params[info['skl_name']] = (
info['type'].from_string(in_tbl.get_column_to_array(name)[0]))
if not copy_through:
for name, info in desc.parameters.items():
if name not in in_tbl.column_names():
skl_params[info['skl_name']] = info['type'].default
skl.set_params(**skl_params)
out_model.set_skl(skl)
out_model.save()
[docs]class SetNames(node.Node):
name = 'Set Input and Output Names'
author = 'Mathias Broxvall'
copyright = '(C) 2017 System Engineering Software Society'
version = '0.1'
icon = 'set_names.svg'
description = 'Sets the name of the inputs and outputs columns of this model'
nodeid = 'org.sysess.sympathy.machinelearning.set_x_names'
tags = Tags(Tag.MachineLearning.Apply)
inputs = Ports([ModelPort('Input model', 'in-model')])
outputs = Ports([ModelPort('Output model', 'out-model')])
parameters = node.parameters()
parameters.set_string(
'input_names', label='Input names', value="X0|X1|X2",
description='List of names for features separated by the | character.'
'All whitespace is included in the final name. If empty then no '
'names are set.')
parameters.set_string(
'output_names', label='Output names', value="Y0",
description=(
'List of names for target separated by the | character. '
'All whitespace is included in the final name. If empty then '
'no names are set.'))
__doc__ = SyML_abstract.generate_docstring2(
description, parameters, inputs, outputs)
def execute(self, node_context):
in_model = node_context.input['in-model']
out_model = node_context.output['out-model']
in_names = node_context.parameters['input_names'].value
out_names = node_context.parameters['output_names'].value
out_model.source(in_model)
out_model.load()
if in_names != "":
out_model.get_desc().set_x_names(in_names.split('|'))
if out_names != "":
out_model.get_desc().set_y_names(out_names.split('|'))
out_model.save()
[docs]class ParameterDistribution(node.Node):
name = 'Parameter Distribution'
author = 'Mathias Broxvall'
copyright = '(C) 2017 System Engineering Software Society'
version = '0.1'
icon = 'parameter_distribution.svg'
description = """Creates a range of values giving a distribution for a parameter"""
nodeid = 'org.sysess.sympathy.machinelearning.parameter_distribution'
tags = Tags(Tag.MachineLearning.HyperParameters)
inputs = Ports([])
outputs = Ports([Port.Table('Output', 'out')])
parameters = node.parameters()
parameters.set_string(
'name', value='N', label='Parameter Name: ',
description='Name of generated column / parameter')
parameters.set_float(
'min', value=0.0, label='Minimum',
description='Lower value in range')
parameters.set_float(
'max', value=1.0, label='Maximum',
description='Upper value in range')
parameters.set_integer(
'N', value=10, label='Number of points',
description='Number of point to generate / to sample')
parameters.set_string(
'method', value='linear', label='Distribution',
description='Type of distribution',
editor=node.Util.combo_editor(options=[
'linear', 'exponential',
]).value())
parameters.set_boolean(
'as_integer', value=False, label='as integer',
description='Forces output to be integers. Removes redundant sample points')
__doc__ = SyML_abstract.generate_docstring2(
description, parameters, inputs, outputs)
def execute(self, node_context):
out = node_context.output['out']
N = node_context.parameters['N'].value
name = node_context.parameters['name'].value
method = node_context.parameters['method'].value
min_value = node_context.parameters['min'].value
max_value = node_context.parameters['max'].value
as_integer = node_context.parameters['as_integer'].value
if method == 'linear':
arr = np.linspace(min_value, max_value, N)
elif method == 'exponential':
arr = np.geomspace(min_value, max_value, N)
else:
raise SyDataError('Invalid method selected')
if as_integer:
arr = np.array(np.round(arr), dtype=int)
arr = np.unique(arr)
out.set_column_from_array(name, arr)
out.set_name('parameter')
