ai.libs.jaicore.ml.cache

Class Instruction

java.lang.Object

ai.libs.jaicore.ml.cache.Instruction

Direct Known Subclasses:

FoldBasedSubsetInstruction, LoadDataSetInstruction, SplitInstruction

public abstract class Instruction
extends java.lang.Object

Instruction class that can be converted into json. Used by ReproducibleInstances. The instructions are used to store information about the dataset origin and the splits done. Supported are LoadDataSetInstruction and FoldBasedSubsetInstruction at the moment.
An instruction is identified by a command name, that specifies the type of instruction and a list if input parameters.

Constructor Summary

Constructors

Constructor and Description
Instruction()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getCommand() Sets command name that specifies the type of instruction represented by the object.
java.util.Map<java.lang.String,java.lang.String>	getInputs() Inputs are parameters of the instruction.
void	setCommand(java.lang.String command) Gets command name that specifies the type of instruction represented by the object.
void	setInputs(java.util.Map<java.lang.String,java.lang.String> inputs) Sets the input parameters that will be used to reproduce the effects done by this instruction.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Instruction

public Instruction()

Method Detail

getCommand

public java.lang.String getCommand()

Sets command name that specifies the type of instruction represented by the object. Every instructions has a unique command name.

Returns:

the name of the command used to identify it.

setCommand

public void setCommand(java.lang.String command)

Gets command name that specifies the type of instruction represented by the object. Every instructions needs a unique command name.

Parameters:

command - name of the command

getInputs

public java.util.Map<java.lang.String,java.lang.String> getInputs()

Inputs are parameters of the instruction. These inputs are used to reproduce the effects of this instruction.

Returns:

the list of input arguments for the instruction

setInputs

public void setInputs(java.util.Map<java.lang.String,java.lang.String> inputs)

Sets the input parameters that will be used to reproduce the effects done by this instruction.

Parameters:

inputs - map of inputs as pairs of to Strings.