You are viewing the RapidMiner Studio documentation for version 10.2 - Check here for latest version
Clone Parameters
(RapidMiner Studio Core)
Synopsis
This operator copies parameter values of the specified source parameters into parameter values of the specified target parameters. This operator is a more generic form of the Set Parameters operator. This operator is mostly used for applying an optimal set of parameters of one operator to another similar operator.Description
The Clone Parameters operator does not require an input whereas the Set Parameters operator takes a set of parameters as input. The Clone Parameters operator can be used for assigning multiple source parameters to multiple target parameters. The source and target parameters can be specified through the name map parameter. This menu has two columns: 'source' and 'target'. The 'source' column is used for specifying the names of the desired parameters whose values will be copied into the target parameters. The 'target' column specifies the names of the target parameters. Both these columns expect values in 'operator.parameter' format where 'operator' is the name of the operator and 'parameter' is the desired parameter. Multiple parameters can be specified by adding more rows in the name map parameter.
This operator is a very generic form of the Set Parameters operator. It differs from the Set Parameters operator because it does not require a ParameterSet as input. It simply reads a parameter value from a source and uses it to set the parameter value of a target parameter. This operator is more generic than the Set Parameters operator and could completely replace it. It is most useful, if you need a parameter which is optimized more than once within the optimization loop - the Set Parameters operator cannot be used here. The fact that this operator does not require an explicit ParameterSet as input and that it does not require the source and target parameters to be exactly the same, makes this operator a lot more generic and powerful than the Set Parameters operator. For more information about the Set Parameters operator please study its documentation
Differentiation
Set Parameters
The Clone Parameters operator is a very generic form of the Set Parameters operator. It differs from the Set Parameters operator because it does not require a ParameterSet as input. It simply reads a parameter value from a source and uses it to set the parameter value of a target parameter. This operator is more generic than the Set Parameters operator and could completely replace it.
Input
through (IOObject)It is not compulsory to connect any object with this port. Any object connected at this port is delivered without any modifications to the output port. This operator can have multiple inputs. When one input is connected, another through input port becomes available which is ready to accept another input (if any). The order of inputs remains the same. The object supplied at the first through input port of this operator is available at the first through output port.
Output
- through (IOObject)
The objects that were given as input are passed without changing to the output through this port. It is not compulsory to attach this port to any other port. This operator can have multiple outputs. When one output is connected, another through output port becomes available which is ready to deliver another output (if any). The order of outputs remains the same. The object delivered at the first through input port of this operator is delivered at the first through output port.
Parameters
- name_mapThe Clone Parameters operator assigns parameter values of the source to those of the target of the specified operators which can be specified through the name map parameter. This menu has two columns: 'source' and 'target'. The 'source' column is used for specifying the names of the desired parameters whose values will be copied into the target parameters. The 'target' column specifies the names of the target parameters. Both these columns expect values in 'operator.parameter' format where 'operator' is the name of the operator and 'parameter' is the desired parameter. Multiple parameters can be specified by adding more rows in the name map parameter. Range: list
Tutorial Processes
Introduction to the Clone Parameters operator
This Example Process highlights the fact that the Clone Parameters operator is a very generic operator which can be used for assigning any parameter value to any other parameter in the process. The task performed in this process does not serve any useful purpose. For understanding a useful scenario of this operator please study the Example Process of the Set Parameters operator.
The Generate Data operator is used for generating an ExampleSet with 10 examples (i.e. number examples parameter = 10). Then the Filter Example Range operator is applied on the 'Golf' ExampleSet. Its first example and last example parameters are set to 1. Thus only the first row of the 'Golf' data set should make it to the output. But have a look at the parameters of the Clone Parameters operator. It assigns the value of the number examples parameter of the Generate Data operator to the last example parameter of the Filter Example Range operator. Thus the last example parameter is set to 10 (previously 1). Therefore instead of only 1 row, the first 10 rows of the 'Golf' data set make it to the output. The resultant ExampleSet can be seen in the Results Workspace. You can see after the execution of the process that the value of the last example parameter has also been changed from 1 to 10. This is how the Clone Parameters operator can be used to dynamically copy parameter values.
