# Uses of Class
org.apache.sysds.api.mlcontext.Script

Packages that use Script
Package
Description
org.apache.sysds.api.mlcontext

## Uses of Script in org.apache.sysds.api.mlcontext

Methods in org.apache.sysds.api.mlcontext that return Script
Modifier and Type
Method
Description
`static Script`
ScriptFactory.`dml(String scriptString)`
Create a DML Script object based on a string.
`static Script`
ScriptFactory.`dmlFromFile(String scriptFilePath)`
Create a DML Script object based on a string path to a file.
`static Script`
ScriptFactory.`dmlFromInputStream(InputStream inputStream)`
Create a DML Script object based on an input stream.
`static Script`
ScriptFactory.`dmlFromLocalFile(File localScriptFile)`
Creates a DML Script object based on a file in the local file system.
`static Script`
ScriptFactory.`dmlFromResource(String resourcePath)`
Create a DML Script object based on a resource path.
`static Script`
ScriptFactory.`dmlFromString(String scriptString)`
Create a DML Script object based on a string.
`static Script`
ScriptFactory.`dmlFromUrl(String scriptUrlPath)`
Create a DML Script object based on a URL path.
`static Script`
ScriptFactory.`dmlFromUrl(URL scriptUrl)`
Create a DML Script object based on a URL.
`Script`
MLResults.`getScript()`
Obtain the Script object associated with these results.
`Script`
ScriptExecutor.`getScript()`
Obtain the Script object associated with this ScriptExecutor
`Script`
Script.`in(String name, Object value)`
Register an input (parameter ($) or variable).
`Script`
Script.`in(String name, Object value, Metadata metadata)`
Register an input (parameter ($) or variable) with optional matrix metadata.
`Script`
Script.`in(Map<String,Object> inputs)`
Pass a map of inputs to the script.
`Script`
Script.`in(scala.collection.Map<String,?> inputs)`
Pass a Scala Map of inputs to the script.
`Script`
Script.`in(scala.collection.Seq<Object> inputs)`
Pass a Scala Seq of inputs to the script.
`Script`
Script.`out(String outputName)`
Register an output variable.
`Script`
Script.`out(String... outputNames)`
Register output variables.
`Script`
Script.`out(List<String> outputNames)`
Register output variables.
`Script`
Script.`out(scala.collection.Seq<String> outputNames)`
Register output variables.
`Script`
Script.`setName(String name)`
Set the script name.
`Script`
Script.`setScriptString(String scriptString)`
Set the script string.
Methods in org.apache.sysds.api.mlcontext with parameters of type Script
Modifier and Type
Method
Description
`void`
ScriptExecutor.`compile(Script script)`
`void`
ScriptExecutor.`compile(Script script, boolean performHOPRewrites)`
Compile a DML or PYDML script.
`MLResults`
MLContext.`execute(Script script)`
Execute a DML or PYDML Script.
`MLResults`
MLContext.`execute(Script script, ScriptExecutor scriptExecutor)`
Execute a DML or PYDML Script object using a ScriptExecutor.
`MLResults`
ScriptExecutor.`execute(Script script)`
Execute a DML or PYDML script.
`void`
MLContext.`setExecutionScript(Script executionScript)`
Sets the script that is being executed
Constructors in org.apache.sysds.api.mlcontext with parameters of type Script
Modifier
Constructor
Description
``
`MLResults(Script script)`