DMLScript (SystemML 0.15.0 API)

java.lang.Object
- org.apache.sysml.api.DMLScript

```
public class DMLScript
extends Object
```

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`DMLScript.DMLOptions` Set of DMLOptions that can be set through the command line and `MLContext` The values have been initialized with the default values Despite there being a DML and PyDML, this class is named DMLOptions to keep it consistent with `DMLScript` and `DMLScript.DMLOptions`
`static class`	`DMLScript.RUNTIME_PLATFORM`

Field Summary

Fields
Modifier and Type	Field and Description
`static boolean`	`_activeAM`
`static boolean`	`_suppressPrint2Stdout`
`static String`	`_uuid`
`static String`	`DML_FILE_PATH_ANTLR_PARSER`
`static boolean`	`ENABLE_DEBUG_MODE`
`static org.apache.sysml.utils.Explain.ExplainType`	`EXPLAIN`
`static boolean`	`FINEGRAINED_STATISTICS`
`static boolean`	`FORCE_ACCELERATOR`
`static DMLScript.RUNTIME_PLATFORM`	`rtplatform`
`static ScriptType`	`SCRIPT_TYPE` Global variable indicating the script type (DML or PYDML).
`static boolean`	`STATISTICS`
`static int`	`STATISTICS_COUNT`
`static int`	`STATISTICS_MAX_WRAP_LEN`
`static boolean`	`USE_ACCELERATOR`
`static boolean`	`USE_LOCAL_SPARK_CONFIG`
`static boolean`	`VALIDATOR_IGNORE_ISSUES` If true, allow DMLProgram to be generated while not halting due to validation errors/warnings

Constructor Summary

Constructors
Constructor and Description

DMLScript()

Constructors
Constructor and Description
`DMLScript()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`cleanupHadoopExecution(org.apache.sysml.conf.DMLConfig config)`
`static org.apache.commons.cli.Options`	`createCLIOptions()` Creates an `Options` instance for the command line parameters As of SystemML 0.13, Apache Commons CLI 1.2 is transitively in the classpath However the most recent version of Apache Commons CLI is 1.4 Creating CLI options is done using Static methods.
`static boolean`	`executeScript(org.apache.hadoop.conf.Configuration conf, String[] args)` Single entry point for all public invocation alternatives (e.g., main, executeScript, JaqlUdf etc)
`static String`	`getUUID()`
`static void`	`initHadoopExecution(org.apache.sysml.conf.DMLConfig config)`
`static boolean`	`isActiveAM()`
`static void`	`main(String[] args)`
`static DMLScript.DMLOptions`	`parseCLArguments(String[] args, org.apache.commons.cli.Options options)` Parses command line arguments to create a `DMLScript.DMLOptions` instance with the correct options
`protected static String`	`readDMLScript(boolean isFile, String scriptOrFilename)` Reads the DML/PyDML script into a String
`static void`	`setActiveAM()`
`static void`	`setUUID(String uuid)` Used to set master UUID on all nodes (in parfor remote_mr, where DMLScript passed) in order to simplify cleanup of scratch_space and local working dirs.
`static boolean`	`suppressPrint2Stdout()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - rtplatform
```
public static DMLScript.RUNTIME_PLATFORM rtplatform
```
  - STATISTICS
```
public static boolean STATISTICS
```
  - FINEGRAINED_STATISTICS
```
public static boolean FINEGRAINED_STATISTICS
```
  - STATISTICS_COUNT
```
public static int STATISTICS_COUNT
```
  - STATISTICS_MAX_WRAP_LEN
```
public static int STATISTICS_MAX_WRAP_LEN
```
  - ENABLE_DEBUG_MODE
```
public static boolean ENABLE_DEBUG_MODE
```
  - EXPLAIN
```
public static org.apache.sysml.utils.Explain.ExplainType EXPLAIN
```
  - DML_FILE_PATH_ANTLR_PARSER
```
public static String DML_FILE_PATH_ANTLR_PARSER
```
  - SCRIPT_TYPE
```
public static ScriptType SCRIPT_TYPE
```
    Global variable indicating the script type (DML or PYDML). Can be used for DML/PYDML-specific tasks, such as outputting booleans in the correct case (TRUE/FALSE for DML and True/False for PYDML).
  - USE_ACCELERATOR
```
public static boolean USE_ACCELERATOR
```
  - FORCE_ACCELERATOR
```
public static boolean FORCE_ACCELERATOR
```
  - _suppressPrint2Stdout
```
public static boolean _suppressPrint2Stdout
```
  - USE_LOCAL_SPARK_CONFIG
```
public static boolean USE_LOCAL_SPARK_CONFIG
```
  - _activeAM
```
public static boolean _activeAM
```
  - VALIDATOR_IGNORE_ISSUES
```
public static boolean VALIDATOR_IGNORE_ISSUES
```
    If true, allow DMLProgram to be generated while not halting due to validation errors/warnings
  - _uuid
```
public static String _uuid
```
- Constructor Detail
  - DMLScript
```
public DMLScript()
```
- Method Detail
  - getUUID
```
public static String getUUID()
```
  - setUUID
```
public static void setUUID(String uuid)
```
    Used to set master UUID on all nodes (in parfor remote_mr, where DMLScript passed) in order to simplify cleanup of scratch_space and local working dirs.
    
    Parameters:
    
    uuid - master UUID to set on all nodes
  - suppressPrint2Stdout
```
public static boolean suppressPrint2Stdout()
```
  - setActiveAM
```
public static void setActiveAM()
```
  - isActiveAM
```
public static boolean isActiveAM()
```
  - main
```
public static void main(String[] args)
                 throws IOException,
                        DMLException
```
    Parameters:
    
    args - command-line arguments
    
    Throws:
    
    IOException - if an IOException occurs
    
    DMLException - if a DMLException occurs
  - parseCLArguments
```
public static DMLScript.DMLOptions parseCLArguments(String[] args,
                                                    org.apache.commons.cli.Options options)
                                             throws org.apache.commons.cli.ParseException
```
    Parses command line arguments to create a DMLScript.DMLOptions instance with the correct options
    
    Parameters:
    
    args - arguments from the command line
    
    options - an Options instance containing the options that need to be parsed
    
    Returns:
    
    an instance of Options that contain the correct Options.
    
    Throws:
    
    org.apache.commons.cli.ParseException - if there is an incorrect option specified in the CLI
  - createCLIOptions
```
public static org.apache.commons.cli.Options createCLIOptions()
```
    Creates an Options instance for the command line parameters As of SystemML 0.13, Apache Commons CLI 1.2 is transitively in the classpath However the most recent version of Apache Commons CLI is 1.4 Creating CLI options is done using Static methods. This obviously makes it thread unsafe. Instead of OptionBuilder, CLI 1.4 uses Option.Builder which has non-static methods.
    
    Returns:
    
    an appropriate instance of Options
  - executeScript
```
public static boolean executeScript(org.apache.hadoop.conf.Configuration conf,
                                    String[] args)
                             throws DMLException
```
    Single entry point for all public invocation alternatives (e.g., main, executeScript, JaqlUdf etc)
    
    Parameters:
    
    conf - Hadoop configuration
    
    args - arguments
    
    Returns:
    
    true if success, false otherwise
    
    Throws:
    
    DMLException - if DMLException occurs
    
    org.apache.sysml.parser.ParseException - if ParseException occurs
  - readDMLScript
```
protected static String readDMLScript(boolean isFile,
                                      String scriptOrFilename)
                               throws IOException,
                                      org.apache.sysml.parser.LanguageException
```
    Reads the DML/PyDML script into a String
    
    Parameters:
    
    isFile - Whether the string argument is a path to a file or the script itself
    
    scriptOrFilename - script or filename
    
    Returns:
    
    a string representation of the script
    
    Throws:
    
    IOException - if error
    
    org.apache.sysml.parser.LanguageException - if error
  - initHadoopExecution
```
public static void initHadoopExecution(org.apache.sysml.conf.DMLConfig config)
                                throws IOException,
                                       org.apache.sysml.parser.ParseException,
                                       DMLRuntimeException
```
    Throws:
    
    IOException
    
    org.apache.sysml.parser.ParseException
    
    DMLRuntimeException
  - cleanupHadoopExecution
```
public static void cleanupHadoopExecution(org.apache.sysml.conf.DMLConfig config)
                                   throws IOException,
                                          org.apache.sysml.parser.ParseException
```
    Throws:
    
    IOException
    
    org.apache.sysml.parser.ParseException

Methods inherited from class java.lang.Object

rtplatform

STATISTICS

FINEGRAINED_STATISTICS

STATISTICS_COUNT

STATISTICS_MAX_WRAP_LEN

ENABLE_DEBUG_MODE

EXPLAIN

DML_FILE_PATH_ANTLR_PARSER

SCRIPT_TYPE

USE_ACCELERATOR

FORCE_ACCELERATOR

_suppressPrint2Stdout

USE_LOCAL_SPARK_CONFIG

_activeAM

VALIDATOR_IGNORE_ISSUES

_uuid

DMLScript

getUUID

setUUID

suppressPrint2Stdout

setActiveAM

isActiveAM

main

parseCLArguments

createCLIOptions

executeScript

readDMLScript

initHadoopExecution

cleanupHadoopExecution