org.apache.sysml.api

Class DMLScript

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.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	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 String	USAGE
static boolean	USE_ACCELERATOR
static boolean	USE_LOCAL_SPARK_CONFIG

Constructor Summary

Constructors

Constructor and Description
DMLScript()

Method Summary

Modifier and Type	Method and Description
static void	cleanupHadoopExecution(org.apache.sysml.conf.DMLConfig config)
protected static Map<String,String>	createArgumentsMap(boolean hasNamedArgs, String[] args)
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) Default DML script invocation (e.g., via 'hadoop jar SystemML.jar -f Test.dml')
protected static String	readDMLScript(String argname, String script)
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

STATISTICS_COUNT

public static int STATISTICS_COUNT

ENABLE_DEBUG_MODE

public static boolean ENABLE_DEBUG_MODE

USE_LOCAL_SPARK_CONFIG

public static boolean USE_LOCAL_SPARK_CONFIG

DML_FILE_PATH_ANTLR_PARSER

public static String DML_FILE_PATH_ANTLR_PARSER

EXPLAIN

public static org.apache.sysml.utils.Explain.ExplainType EXPLAIN

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

_uuid

public static String _uuid

_activeAM

public static boolean _activeAM

USAGE

public static String USAGE

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

Default DML script invocation (e.g., via 'hadoop jar SystemML.jar -f Test.dml')

Parameters:

args - command-line arguments

Throws:

IOException - if an IOException occurs

DMLException - if a DMLException occurs

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

createArgumentsMap

protected static Map<String,String> createArgumentsMap(boolean hasNamedArgs,
                                                       String[] args)
                                                throws org.apache.sysml.parser.LanguageException

Throws:

org.apache.sysml.parser.LanguageException

readDMLScript

protected static String readDMLScript(String argname,
                                      String script)
                               throws IOException,
                                      org.apache.sysml.parser.LanguageException

Throws:

IOException

org.apache.sysml.parser.LanguageException

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