Script (Apache SystemDS 3.4.0-SNAPSHOT API)
void
clearAll()
Clear the script string, inputs, outputs, and symbol table.
void
clearInputs()
Clear the inputs.
void
clearIO()
Clear the inputs and outputs, but not the symbol table.
void
clearIOS()
Clear the inputs, outputs, and symbol table.
void
clearOutputs()
Clear the outputs.
void
clearSymbolTable()
Clear the symbol table.
String
displayInputParameters()
Display the script input parameters.
String
displayInputs()
Display the script inputs.
String
displayInputVariables()
Display the script input variables.
String
displayOutputs()
Display the script outputs.
String
displayOutputVariables()
Display the script output variables.
String
displaySymbolTable()
Display the script symbol table.
MLResults
execute()
Execute the script and return the results as an MLResults object.
Map<String,Metadata>
getInputMetadata()
Obtain an unmodifiable map of input matrix/frame metadata.
Map<String,Object>
getInputParameters()
Obtain an unmodifiable map of all input parameters ($).
Map<String,Object>
getInputs()
Obtain an unmodifiable map of all inputs (parameters ($) and variables).
Set<String>
getInputVariables()
Obtain the input variable names as an unmodifiable set of strings.
String
getName()
Obtain the script name.
Set<String>
getOutputVariables()
Obtain the output variable names as an unmodifiable set of strings.
MLResults
getResults()
Obtain the results of the script execution.
String
getScriptExecutionString()
Generate the script execution string, which adds read/load/write/save statements to the beginning and end of the script to execute.
ScriptExecutor
getScriptExecutor()
Obtain the script executor used by this Script.
String
getScriptString()
Obtain the script string.
LocalVariableMap
getSymbolTable()
Obtain the symbol table, which is essentially a
HashMap<String, Data> representing variables and their values.
Script
in(String name,
Object value)
Register an input (parameter ($) or variable).
Script
in(String name,
Object value,
Metadata metadata)
Register an input (parameter ($) or variable) with optional matrix metadata.
Script
in(Map<String,Object> inputs)
Pass a map of inputs to the script.
Script
in(scala.collection.Map<String,?> inputs)
Pass a Scala Map of inputs to the script.
Script
in(scala.collection.Seq<Object> inputs)
Pass a Scala Seq of inputs to the script.
String
info()
Display information about the script as a String.
Script
out(String outputName)
Register an output variable.
Script
out(String... outputNames)
Register output variables.
Script
out(List<String> outputNames)
Register output variables.
Script
out(scala.collection.Seq<String> outputNames)
Register output variables.
MLResults
results()
Obtain the results of the script execution.
Script
setName(String name)
Set the script name.
void
setResults(MLResults results)
Set the results of the script execution.
void
setScriptExecutor(ScriptExecutor scriptExecutor)
Set the ScriptExecutor used by this Script.
Script
setScriptString(String scriptString)
Set the script string.
String
toString()