org.apache.sysml.api

Class MLOutput

java.lang.Object

org.apache.sysml.api.MLOutput

Deprecated.

This will be removed in SystemML 1.0. Please migrate to MLContext and MLResults

@Deprecated
public class MLOutput
extends Object

This is a simple container object that returns the output of execute from MLContext

Constructor Summary

Constructors

Constructor and Description
MLOutput(Map<String,org.apache.spark.api.java.JavaPairRDD<?,?>> outputs, Map<String,MatrixCharacteristics> outMetadata) Deprecated.

Method Summary

Modifier and Type	Method and Description
org.apache.spark.api.java.JavaPairRDD<MatrixIndexes,MatrixBlock>	getBinaryBlockedRDD(String varName) Deprecated.
org.apache.spark.sql.Dataset<org.apache.spark.sql.Row>	getDataFrameRDD(String varName, org.apache.spark.api.java.JavaSparkContext jsc) Deprecated.
org.apache.spark.sql.Dataset<org.apache.spark.sql.Row>	getDF(org.apache.spark.sql.SparkSession sparkSession, String varName) Deprecated. Note, the output DataFrame has an additional column ID.
org.apache.spark.sql.Dataset<org.apache.spark.sql.Row>	getDF(org.apache.spark.sql.SparkSession sparkSession, String varName, boolean outputVector) Deprecated. Obtain the DataFrame
org.apache.spark.sql.Dataset<org.apache.spark.sql.Row>	getDF(org.apache.spark.sql.SparkSession sparkSession, String varName, MatrixCharacteristics mc) Deprecated. This methods improves the performance of MLPipeline wrappers.
org.apache.spark.sql.Dataset<org.apache.spark.sql.Row>	getDF(org.apache.spark.sql.SQLContext sqlContext, String varName) Deprecated. Note, the output DataFrame has an additional column ID.
org.apache.spark.sql.Dataset<org.apache.spark.sql.Row>	getDF(org.apache.spark.sql.SQLContext sqlContext, String varName, boolean outputVector) Deprecated. Obtain the DataFrame
org.apache.spark.sql.Dataset<org.apache.spark.sql.Row>	getDF(org.apache.spark.sql.SQLContext sqlContext, String varName, MatrixCharacteristics mc) Deprecated. This methods improves the performance of MLPipeline wrappers.
org.apache.spark.api.java.JavaPairRDD<Long,FrameBlock>	getFrameBinaryBlockedRDD(String varName) Deprecated.
MatrixBlock	getMatrixBlock(String varName) Deprecated.
MatrixCharacteristics	getMatrixCharacteristics(String varName) Deprecated.
MLMatrix	getMLMatrix(MLContext ml, org.apache.spark.sql.SparkSession sparkSession, String varName) Deprecated.
MLMatrix	getMLMatrix(MLContext ml, org.apache.spark.sql.SQLContext sqlContext, String varName) Deprecated.
org.apache.spark.api.java.JavaRDD<String>	getStringFrameRDD(String varName, String format, CSVFileFormatProperties fprop) Deprecated.
org.apache.spark.api.java.JavaRDD<String>	getStringRDD(String varName, String format) Deprecated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MLOutput

public MLOutput(Map<String,org.apache.spark.api.java.JavaPairRDD<?,?>> outputs,
                Map<String,MatrixCharacteristics> outMetadata)

Deprecated.

Method Detail

getMatrixBlock

public MatrixBlock getMatrixBlock(String varName)
                           throws DMLRuntimeException

Deprecated.

Throws:

DMLRuntimeException

getBinaryBlockedRDD

public org.apache.spark.api.java.JavaPairRDD<MatrixIndexes,MatrixBlock> getBinaryBlockedRDD(String varName)
                                                                                     throws DMLRuntimeException

Deprecated.

Throws:

DMLRuntimeException

getFrameBinaryBlockedRDD

public org.apache.spark.api.java.JavaPairRDD<Long,FrameBlock> getFrameBinaryBlockedRDD(String varName)
                                                                                throws DMLRuntimeException

Deprecated.

Throws:

DMLRuntimeException

getMatrixCharacteristics

public MatrixCharacteristics getMatrixCharacteristics(String varName)
                                               throws DMLRuntimeException

Deprecated.

Throws:

DMLRuntimeException

getDF

public org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> getDF(org.apache.spark.sql.SparkSession sparkSession,
                                                                    String varName)
                                                             throws DMLRuntimeException

Deprecated.

Note, the output DataFrame has an additional column ID. An easy way to get DataFrame without ID is by df.drop("__INDEX")

Parameters:

sparkSession - the Spark Session

varName - the variable name

Returns:

the DataFrame

Throws:

DMLRuntimeException - if DMLRuntimeException occurs

getDF

public org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> getDF(org.apache.spark.sql.SQLContext sqlContext,
                                                                    String varName)
                                                             throws DMLRuntimeException

Deprecated.

Note, the output DataFrame has an additional column ID. An easy way to get DataFrame without ID is by df.drop("__INDEX")

Parameters:

sqlContext - the SQL Context

varName - the variable name

Returns:

the DataFrame

Throws:

DMLRuntimeException - if DMLRuntimeException occurs

getDF

public org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> getDF(org.apache.spark.sql.SparkSession sparkSession,
                                                                    String varName,
                                                                    boolean outputVector)
                                                             throws DMLRuntimeException

Deprecated.

Obtain the DataFrame

Parameters:

sparkSession - the Spark Session

varName - the variable name

outputVector - if true, returns DataFrame with two column: ID and org.apache.spark.ml.linalg.Vector

Returns:

the DataFrame

Throws:

DMLRuntimeException - if DMLRuntimeException occurs

getDF

public org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> getDF(org.apache.spark.sql.SQLContext sqlContext,
                                                                    String varName,
                                                                    boolean outputVector)
                                                             throws DMLRuntimeException

Deprecated.

Obtain the DataFrame

Parameters:

sqlContext - the SQL Context

varName - the variable name

outputVector - if true, returns DataFrame with two column: ID and org.apache.spark.ml.linalg.Vector

Returns:

the DataFrame

Throws:

DMLRuntimeException - if DMLRuntimeException occurs

getDF

public org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> getDF(org.apache.spark.sql.SparkSession sparkSession,
                                                                    String varName,
                                                                    MatrixCharacteristics mc)
                                                             throws DMLRuntimeException

Deprecated.

This methods improves the performance of MLPipeline wrappers.

Parameters:

sparkSession - the Spark Session

varName - the variable name

mc - the matrix characteristics

Returns:

the DataFrame

Throws:

DMLRuntimeException - if DMLRuntimeException occurs

getDF

public org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> getDF(org.apache.spark.sql.SQLContext sqlContext,
                                                                    String varName,
                                                                    MatrixCharacteristics mc)
                                                             throws DMLRuntimeException

Deprecated.

This methods improves the performance of MLPipeline wrappers.

Parameters:

sqlContext - the SQL Context

varName - the variable name

mc - the matrix characteristics

Returns:

the DataFrame

Throws:

DMLRuntimeException - if DMLRuntimeException occurs

getStringRDD

public org.apache.spark.api.java.JavaRDD<String> getStringRDD(String varName,
                                                              String format)
                                                       throws DMLRuntimeException

Deprecated.

Throws:

DMLRuntimeException

getStringFrameRDD

public org.apache.spark.api.java.JavaRDD<String> getStringFrameRDD(String varName,
                                                                   String format,
                                                                   CSVFileFormatProperties fprop)
                                                            throws DMLRuntimeException

Deprecated.

Throws:

DMLRuntimeException

getDataFrameRDD

public org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> getDataFrameRDD(String varName,
                                                                              org.apache.spark.api.java.JavaSparkContext jsc)
                                                                       throws DMLRuntimeException

Deprecated.

Throws:

DMLRuntimeException

getMLMatrix

public MLMatrix getMLMatrix(MLContext ml,
                            org.apache.spark.sql.SparkSession sparkSession,
                            String varName)
                     throws DMLRuntimeException

Deprecated.

Throws:

DMLRuntimeException

getMLMatrix

public MLMatrix getMLMatrix(MLContext ml,
                            org.apache.spark.sql.SQLContext sqlContext,
                            String varName)
                     throws DMLRuntimeException

Deprecated.

Throws:

DMLRuntimeException