Package org.apache.sysds.api

Class DMLScript

java.lang.Object
org.apache.sysds.api.DMLScript
public class DMLScript extends Object

  • Field Details

    • STATISTICS

      public static boolean STATISTICS

    • STATISTICS_NGRAMS

      public static boolean STATISTICS_NGRAMS

    • JMLC_MEM_STATISTICS

      public static boolean JMLC_MEM_STATISTICS

    • STATISTICS_COUNT

      public static int STATISTICS_COUNT

    • STATISTICS_NGRAM_SIZES

      public static int[] STATISTICS_NGRAM_SIZES

    • STATISTICS_TOP_K_NGRAMS

      public static int STATISTICS_TOP_K_NGRAMS

    • STATISTICS_NGRAMS_USE_LINEAGE

      public static boolean STATISTICS_NGRAMS_USE_LINEAGE

    • STATISTICS_MAX_WRAP_LEN

      public static int STATISTICS_MAX_WRAP_LEN

    • FED_STATISTICS

      public static boolean FED_STATISTICS

    • FED_STATISTICS_COUNT

      public static int FED_STATISTICS_COUNT

    • FED_WORKER

      public static boolean FED_WORKER

    • EXPLAIN

      public static Explain.ExplainType EXPLAIN

    • DML_FILE_PATH_ANTLR_PARSER

      public static String DML_FILE_PATH_ANTLR_PARSER

    • FLOATING_POINT_PRECISION

      public static String FLOATING_POINT_PRECISION

    • EVICTION_SHADOW_BUFFER_MAX_BYTES

      public static long EVICTION_SHADOW_BUFFER_MAX_BYTES

    • EVICTION_SHADOW_BUFFER_CURR_BYTES

      public static long EVICTION_SHADOW_BUFFER_CURR_BYTES

    • GPU_MEMORY_UTILIZATION_FACTOR

      public static double GPU_MEMORY_UTILIZATION_FACTOR

    • GPU_MEMORY_ALLOCATOR

      public static String GPU_MEMORY_ALLOCATOR

    • LINEAGE

      public static boolean LINEAGE

    • LINEAGE_DEDUP

      public static boolean LINEAGE_DEDUP

    • LINEAGE_REUSE

      public static LineageCacheConfig.ReuseCacheType LINEAGE_REUSE

    • LINEAGE_POLICY

      public static LineageCacheConfig.LineageCachePolicy LINEAGE_POLICY

    • LINEAGE_ESTIMATE

      public static boolean LINEAGE_ESTIMATE

    • LINEAGE_DEBUGGER

      public static boolean LINEAGE_DEBUGGER

    • USE_ACCELERATOR

      public static boolean USE_ACCELERATOR

    • FORCE_ACCELERATOR

      public static boolean FORCE_ACCELERATOR

    • SYNCHRONIZE_GPU

      public static boolean SYNCHRONIZE_GPU

    • USE_OOC

      public static boolean USE_OOC

    • OOC_STATISTICS

      public static boolean OOC_STATISTICS

    • OOC_STATISTICS_COUNT

      public static int OOC_STATISTICS_COUNT

    • OOC_LOG_EVENTS

      public static boolean OOC_LOG_EVENTS

    • OOC_LOG_PATH

      public static String OOC_LOG_PATH

    • EAGER_CUDA_FREE

      public static boolean EAGER_CUDA_FREE

    • SEED

      public static int SEED

    • SPARSE_INTERMEDIATE

      public static boolean SPARSE_INTERMEDIATE

    • MONITORING_ADDRESS

      public static String MONITORING_ADDRESS

    • _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 Details

    • DMLScript

      public DMLScript()

  • Method Details

    • getUUID

      public static String getUUID()

    • setUUID

      public static void setUUID(String uuid)
      Used to set master UUID on all nodes (in parfor remote, 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)
      Main entry point for systemDS dml script execution
      Parameters:
      args - command-line arguments

    • executeScript

      public static boolean executeScript(String[] args) throws IOException, ParseException, DMLScriptException
      Single entry point for all public invocation alternatives (e.g., main, executeScript, JaqlUdf etc)
      Parameters:
      args - arguments
      Returns:
      true if success, false otherwise
      Throws:
      IOException - If an internal IOException happens.
      ParseException
      DMLScriptException

    • readDMLScript

      public static String readDMLScript(boolean isFile, String scriptOrFilename) throws IOException
      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

    • loadConfiguration

      public static void loadConfiguration(String fnameOptConfig) throws IOException
      Throws:
      IOException

    • setGlobalFlags

      public static void setGlobalFlags(DMLConfig dmlconf)
      Sets the global flags in DMLScript based on user provided configuration
      Parameters:
      dmlconf - user provided configuration

    • initHadoopExecution

      public static void initHadoopExecution(DMLConfig config) throws IOException, ParseException, DMLRuntimeException
      Throws:
      IOException
      ParseException
      DMLRuntimeException

    • cleanupHadoopExecution

      public static void cleanupHadoopExecution(DMLConfig config) throws IOException, ParseException
      Throws:
      IOException
      ParseException

    • getGlobalExecMode

      public static Types.ExecMode getGlobalExecMode()

    • setGlobalExecMode

      public static void setGlobalExecMode(Types.ExecMode mode)

    • errorPrint

      public static void errorPrint(Exception e)
      Print the error in a user friendly manner.
      Parameters:
      e - The exception thrown.