DMLConfig (SystemDS 2.1.0 API)

java.lang.Object
- org.apache.sysds.conf.DMLConfig

```
public class DMLConfig
extends Object
```

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`AVAILABLE_GPUS`
`static String`	`CODEGEN`
`static String`	`CODEGEN_API`
`static String`	`CODEGEN_COMPILER`
`static String`	`CODEGEN_LITERALS`
`static String`	`CODEGEN_OPTIMIZER`
`static String`	`CODEGEN_PLANCACHE`
`static String`	`COMPILERASSISTED_RW`
`static String`	`COMPRESSED_COCODE`
`static String`	`COMPRESSED_LINALG`
`static String`	`COMPRESSED_LOSSY`
`static String`	`COMPRESSED_OVERLAPPING`
`static String`	`COMPRESSED_SAMPLING_RATIO`
`static String`	`COMPRESSED_TRANSPOSE`
`static String`	`COMPRESSED_VALID_COMPRESSIONS`
`static String`	`CP_PARALLEL_IO`
`static String`	`CP_PARALLEL_OPS`
`static String`	`DEFAULT_BLOCK_SIZE`
`static String`	`DEFAULT_FEDERATED_INITIALIZATION_TIMEOUT`
`static int`	`DEFAULT_FEDERATED_PORT`
`static int`	`DEFAULT_NUMBER_OF_FEDERATED_WORKER_THREADS`
`static String`	`DEFAULT_SHARED_DIR_PERMISSION`
`static String`	`DEFAULT_SYSTEMDS_CONFIG_FILEPATH`
`static String`	`EAGER_CUDA_FREE`
`static String`	`EVICTION_SHADOW_BUFFERSIZE`
`static String`	`FLOATING_POINT_PRECISION`
`static String`	`GPU_EVICTION_POLICY`
`static String`	`GPU_MEMORY_ALLOCATOR`
`static String`	`GPU_MEMORY_UTILIZATION_FACTOR`
`static String`	`LINEAGECACHESPILL`
`static String`	`LOCAL_SPARK_NUM_THREADS`
`static String`	`LOCAL_TMP_DIR`
`static String`	`NATIVE_BLAS`
`static String`	`NATIVE_BLAS_DIR`
`static String`	`OPTIMIZATION_LEVEL`
`static String`	`PRINT_GPU_MEMORY_INFO`
`static String`	`SCRATCH_SPACE`
`static String`	`STATS_MAX_WRAP_LEN`
`static String`	`SYNCHRONIZE_GPU`
`static String`	`USE_SSL_FEDERATED_COMMUNICATION`

Constructor Summary

Constructors
Constructor and Description
`DMLConfig()`
`DMLConfig(DMLConfig dmlconf)`
`DMLConfig(Element root)`
`DMLConfig(String fileName)`
`DMLConfig(String fileName, boolean silent)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DMLConfig`	`clone()`
`boolean`	`getBooleanValue(String tagName)`
`String`	`getConfigInfo()`
`static String`	`getDefaultTextValue(String key)`
`double`	`getDoubleValue(String tagName)`
`int`	`getIntValue(String tagName)`
`String`	`getTextValue(String tagName)` Method to get string value of a configuration parameter Handles processing of configuration parameters
`static DMLConfig`	`parseDMLConfig(String content)`
`static DMLConfig`	`readConfigurationFile(String configPath)` Start with the internal default settings, then merge in the settings from any specified configuration file, if available.
`String`	`serializeDMLConfig()`
`void`	`set(DMLConfig dmlconf)`
`void`	`setTextValue(String paramName, String paramValue)` Method to update the key value

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

- Field Detail
  - DEFAULT_SYSTEMDS_CONFIG_FILEPATH
```
public static final String DEFAULT_SYSTEMDS_CONFIG_FILEPATH
```
    See Also:
    
    Constant Field Values
  - LOCAL_TMP_DIR
```
public static final String LOCAL_TMP_DIR
```
    See Also:
    
    Constant Field Values
  - SCRATCH_SPACE
```
public static final String SCRATCH_SPACE
```
    See Also:
    
    Constant Field Values
  - OPTIMIZATION_LEVEL
```
public static final String OPTIMIZATION_LEVEL
```
    See Also:
    
    Constant Field Values
  - DEFAULT_BLOCK_SIZE
```
public static final String DEFAULT_BLOCK_SIZE
```
    See Also:
    
    Constant Field Values
  - CP_PARALLEL_OPS
```
public static final String CP_PARALLEL_OPS
```
    See Also:
    
    Constant Field Values
  - CP_PARALLEL_IO
```
public static final String CP_PARALLEL_IO
```
    See Also:
    
    Constant Field Values
  - COMPRESSED_LINALG
```
public static final String COMPRESSED_LINALG
```
    See Also:
    
    Constant Field Values
  - COMPRESSED_LOSSY
```
public static final String COMPRESSED_LOSSY
```
    See Also:
    
    Constant Field Values
  - COMPRESSED_VALID_COMPRESSIONS
```
public static final String COMPRESSED_VALID_COMPRESSIONS
```
    See Also:
    
    Constant Field Values
  - COMPRESSED_OVERLAPPING
```
public static final String COMPRESSED_OVERLAPPING
```
    See Also:
    
    Constant Field Values
  - COMPRESSED_SAMPLING_RATIO
```
public static final String COMPRESSED_SAMPLING_RATIO
```
    See Also:
    
    Constant Field Values
  - COMPRESSED_COCODE
```
public static final String COMPRESSED_COCODE
```
    See Also:
    
    Constant Field Values
  - COMPRESSED_TRANSPOSE
```
public static final String COMPRESSED_TRANSPOSE
```
    See Also:
    
    Constant Field Values
  - NATIVE_BLAS
```
public static final String NATIVE_BLAS
```
    See Also:
    
    Constant Field Values
  - NATIVE_BLAS_DIR
```
public static final String NATIVE_BLAS_DIR
```
    See Also:
    
    Constant Field Values
  - CODEGEN
```
public static final String CODEGEN
```
    See Also:
    
    Constant Field Values
  - CODEGEN_API
```
public static final String CODEGEN_API
```
    See Also:
    
    Constant Field Values
  - CODEGEN_COMPILER
```
public static final String CODEGEN_COMPILER
```
    See Also:
    
    Constant Field Values
  - CODEGEN_OPTIMIZER
```
public static final String CODEGEN_OPTIMIZER
```
    See Also:
    
    Constant Field Values
  - CODEGEN_PLANCACHE
```
public static final String CODEGEN_PLANCACHE
```
    See Also:
    
    Constant Field Values
  - CODEGEN_LITERALS
```
public static final String CODEGEN_LITERALS
```
    See Also:
    
    Constant Field Values
  - STATS_MAX_WRAP_LEN
```
public static final String STATS_MAX_WRAP_LEN
```
    See Also:
    
    Constant Field Values
  - AVAILABLE_GPUS
```
public static final String AVAILABLE_GPUS
```
    See Also:
    
    Constant Field Values
  - SYNCHRONIZE_GPU
```
public static final String SYNCHRONIZE_GPU
```
    See Also:
    
    Constant Field Values
  - EAGER_CUDA_FREE
```
public static final String EAGER_CUDA_FREE
```
    See Also:
    
    Constant Field Values
  - GPU_EVICTION_POLICY
```
public static final String GPU_EVICTION_POLICY
```
    See Also:
    
    Constant Field Values
  - LOCAL_SPARK_NUM_THREADS
```
public static final String LOCAL_SPARK_NUM_THREADS
```
    See Also:
    
    Constant Field Values
  - LINEAGECACHESPILL
```
public static final String LINEAGECACHESPILL
```
    See Also:
    
    Constant Field Values
  - COMPILERASSISTED_RW
```
public static final String COMPILERASSISTED_RW
```
    See Also:
    
    Constant Field Values
  - GPU_MEMORY_UTILIZATION_FACTOR
```
public static final String GPU_MEMORY_UTILIZATION_FACTOR
```
    See Also:
    
    Constant Field Values
  - GPU_MEMORY_ALLOCATOR
```
public static final String GPU_MEMORY_ALLOCATOR
```
    See Also:
    
    Constant Field Values
  - FLOATING_POINT_PRECISION
```
public static final String FLOATING_POINT_PRECISION
```
    See Also:
    
    Constant Field Values
  - PRINT_GPU_MEMORY_INFO
```
public static final String PRINT_GPU_MEMORY_INFO
```
    See Also:
    
    Constant Field Values
  - EVICTION_SHADOW_BUFFERSIZE
```
public static final String EVICTION_SHADOW_BUFFERSIZE
```
    See Also:
    
    Constant Field Values
  - USE_SSL_FEDERATED_COMMUNICATION
```
public static final String USE_SSL_FEDERATED_COMMUNICATION
```
    See Also:
    
    Constant Field Values
  - DEFAULT_FEDERATED_INITIALIZATION_TIMEOUT
```
public static final String DEFAULT_FEDERATED_INITIALIZATION_TIMEOUT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_FEDERATED_PORT
```
public static final int DEFAULT_FEDERATED_PORT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_NUMBER_OF_FEDERATED_WORKER_THREADS
```
public static final int DEFAULT_NUMBER_OF_FEDERATED_WORKER_THREADS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SHARED_DIR_PERMISSION
```
public static final String DEFAULT_SHARED_DIR_PERMISSION
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - DMLConfig
```
public DMLConfig()
```
  - DMLConfig
```
public DMLConfig(String fileName)
          throws FileNotFoundException
```
    Throws:
    
    FileNotFoundException
  - DMLConfig
```
public DMLConfig(String fileName,
                 boolean silent)
          throws FileNotFoundException
```
    Throws:
    
    FileNotFoundException
  - DMLConfig
```
public DMLConfig(Element root)
```
  - DMLConfig
```
public DMLConfig(DMLConfig dmlconf)
```
- Method Detail
  - set
```
public void set(DMLConfig dmlconf)
```
  - getTextValue
```
public String getTextValue(String tagName)
```
    Method to get string value of a configuration parameter Handles processing of configuration parameters
    
    Parameters:
    
    tagName - the name of the DMLConfig parameter being retrieved
    
    Returns:
    
    a string representation of the DMLConfig parameter value.
  - getIntValue
```
public int getIntValue(String tagName)
```
  - getBooleanValue
```
public boolean getBooleanValue(String tagName)
```
  - getDoubleValue
```
public double getDoubleValue(String tagName)
```
  - setTextValue
```
public void setTextValue(String paramName,
                         String paramValue)
```
    Method to update the key value
    
    Parameters:
    
    paramName - parameter name
    
    paramValue - parameter value
  - serializeDMLConfig
```
public String serializeDMLConfig()
```
  - parseDMLConfig
```
public static DMLConfig parseDMLConfig(String content)
```
  - readConfigurationFile
```
public static DMLConfig readConfigurationFile(String configPath)
                                       throws FileNotFoundException
```
    Start with the internal default settings, then merge in the settings from any specified configuration file, if available. If it is not explicitly given, then merge in settings from the default configuration file location, if available.
    
    Parameters:
    
    configPath - User-defined path of the configuration file.
    
    Returns:
    
    dml configuration
    
    Throws:
    
    FileNotFoundException - if FileNotFoundException occurs
  - getConfigInfo
```
public String getConfigInfo()
```
  - getDefaultTextValue
```
public static String getDefaultTextValue(String key)
```
  - clone
```
public DMLConfig clone()
```
    Overrides:
    
    clone in class Object

Class DMLConfig

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_SYSTEMDS_CONFIG_FILEPATH

LOCAL_TMP_DIR

SCRATCH_SPACE

OPTIMIZATION_LEVEL

DEFAULT_BLOCK_SIZE

CP_PARALLEL_OPS

CP_PARALLEL_IO

COMPRESSED_LINALG

COMPRESSED_LOSSY

COMPRESSED_VALID_COMPRESSIONS

COMPRESSED_OVERLAPPING

COMPRESSED_SAMPLING_RATIO

COMPRESSED_COCODE

COMPRESSED_TRANSPOSE

NATIVE_BLAS

NATIVE_BLAS_DIR

CODEGEN

CODEGEN_API

CODEGEN_COMPILER

CODEGEN_OPTIMIZER

CODEGEN_PLANCACHE

CODEGEN_LITERALS

STATS_MAX_WRAP_LEN

AVAILABLE_GPUS

SYNCHRONIZE_GPU

EAGER_CUDA_FREE

GPU_EVICTION_POLICY

LOCAL_SPARK_NUM_THREADS

LINEAGECACHESPILL

COMPILERASSISTED_RW

GPU_MEMORY_UTILIZATION_FACTOR

GPU_MEMORY_ALLOCATOR

FLOATING_POINT_PRECISION

PRINT_GPU_MEMORY_INFO

EVICTION_SHADOW_BUFFERSIZE

USE_SSL_FEDERATED_COMMUNICATION

DEFAULT_FEDERATED_INITIALIZATION_TIMEOUT

DEFAULT_FEDERATED_PORT

DEFAULT_NUMBER_OF_FEDERATED_WORKER_THREADS

DEFAULT_SHARED_DIR_PERMISSION

Constructor Detail

DMLConfig

DMLConfig

DMLConfig

DMLConfig

DMLConfig

Method Detail

set

getTextValue

getIntValue

getBooleanValue

getDoubleValue

setTextValue

serializeDMLConfig

parseDMLConfig

readConfigurationFile

getConfigInfo

getDefaultTextValue

clone