You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@systemml.apache.org by de...@apache.org on 2016/09/08 21:09:47 UTC

incubator-systemml git commit: [SYSTEMML-891] Update MLContext Matrix and Frame 'as' methods to 'to'

Repository: incubator-systemml
Updated Branches:
  refs/heads/master aa851f681 -> 24f8c5e6d


[SYSTEMML-891] Update MLContext Matrix and Frame 'as' methods to 'to'

Update 'as' methods to 'to' methods to more closely follow Spark conventions.

Closes #235.


Project: http://git-wip-us.apache.org/repos/asf/incubator-systemml/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-systemml/commit/24f8c5e6
Tree: http://git-wip-us.apache.org/repos/asf/incubator-systemml/tree/24f8c5e6
Diff: http://git-wip-us.apache.org/repos/asf/incubator-systemml/diff/24f8c5e6

Branch: refs/heads/master
Commit: 24f8c5e6d1a5a941ac1b6d90b1c495ddcfe9afac
Parents: aa851f6
Author: Deron Eriksson <de...@us.ibm.com>
Authored: Thu Sep 8 14:06:28 2016 -0700
Committer: Deron Eriksson <de...@us.ibm.com>
Committed: Thu Sep 8 14:06:28 2016 -0700

----------------------------------------------------------------------
 docs/spark-mlcontext-programming-guide.md       | 24 +++++++++---------
 .../org/apache/sysml/api/mlcontext/Frame.java   | 16 ++++++------
 .../api/mlcontext/MLContextConversionUtil.java  |  2 +-
 .../sysml/api/mlcontext/MLContextUtil.java      |  4 +--
 .../apache/sysml/api/mlcontext/MLResults.java   |  2 +-
 .../org/apache/sysml/api/mlcontext/Matrix.java  | 26 ++++++++++----------
 src/main/python/systemml/mlcontext.py           |  4 +--
 7 files changed, 39 insertions(+), 39 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/24f8c5e6/docs/spark-mlcontext-programming-guide.md
----------------------------------------------------------------------
diff --git a/docs/spark-mlcontext-programming-guide.md b/docs/spark-mlcontext-programming-guide.md
index 95a5269..bed05ad 100644
--- a/docs/spark-mlcontext-programming-guide.md
+++ b/docs/spark-mlcontext-programming-guide.md
@@ -467,10 +467,10 @@ n = sum(m)
 val scr = dml(s).out("m", "n");
 val res = ml.execute(scr)
 val (x, y) = res.getTuple[Matrix, Double]("m", "n")
-x.asRDDStringIJV.collect.foreach(println)
-x.asRDDStringCSV.collect.foreach(println)
-x.asDataFrame.collect.foreach(println)
-x.asDoubleMatrix
+x.toRDDStringIJV.collect.foreach(println)
+x.toRDDStringCSV.collect.foreach(println)
+x.toDF.collect.foreach(println)
+x.to2DDoubleArray
 
 {% endhighlight %}
 </div>
@@ -508,21 +508,21 @@ scala> val (x, y) = res.getTuple[Matrix, Double]("m", "n")
 x: org.apache.sysml.api.mlcontext.Matrix = Matrix: scratch_space//_p12059_9.31.117.12//_t0/temp26_14, [2 x 2, nnz=4, blocks (1000 x 1000)], binaryblock, dirty
 y: Double = 110.0
 
-scala> x.asRDDStringIJV.collect.foreach(println)
+scala> x.toRDDStringIJV.collect.foreach(println)
 1 1 11.0
 1 2 22.0
 2 1 33.0
 2 2 44.0
 
-scala> x.asRDDStringCSV.collect.foreach(println)
+scala> x.toRDDStringCSV.collect.foreach(println)
 11.0,22.0
 33.0,44.0
 
-scala> x.asDataFrame.collect.foreach(println)
+scala> x.toDF.collect.foreach(println)
 [0.0,11.0,22.0]
 [1.0,33.0,44.0]
 
-scala> x.asDoubleMatrix
+scala> x.to2DDoubleArray
 res10: Array[Array[Double]] = Array(Array(11.0, 22.0), Array(33.0, 44.0))
 
 {% endhighlight %}
@@ -821,7 +821,7 @@ the input types matrix to the `K` variable, and the output matrix to the `baseSt
 {% highlight scala %}
 val uni = dmlFromUrl(scriptUrl).in("A", habermanRDD, habermanMetadata).in("K", typesRDD, typesMetadata).out("baseStats")
 val baseStats = ml.execute(uni).getMatrix("baseStats")
-baseStats.asRDDStringIJV.collect.slice(0,9).foreach(println)
+baseStats.toRDDStringIJV.collect.slice(0,9).foreach(println)
 {% endhighlight %}
 </div>
 
@@ -841,7 +841,7 @@ scala> val baseStats = ml.execute(uni).getMatrix("baseStats")
 ...
 baseStats: org.apache.sysml.api.mlcontext.Matrix = Matrix: scratch_space/_p12059_9.31.117.12/parfor/4_resultmerge1, [17 x 4, nnz=44, blocks (1000 x 1000)], binaryblock, dirty
 
-scala> baseStats.asRDDStringIJV.collect.slice(0,9).foreach(println)
+scala> baseStats.toRDDStringIJV.collect.slice(0,9).foreach(println)
 1 1 30.0
 1 2 58.0
 1 3 0.0
@@ -1592,7 +1592,7 @@ val add = dml("y = x + 1").in("x", rddCSV).out("y")
 for (i <- 1 to 5) {
   println("#" + i + ":");
   val m = ml.execute(add).getMatrix("y")
-  m.asRDDStringCSV.collect.foreach(println)
+  m.toRDDStringCSV.collect.foreach(println)
   add.in("x", m)
 }
 
@@ -1616,7 +1616,7 @@ Outputs:
 scala> for (i <- 1 to 5) {
      |   println("#" + i + ":");
      |   val m = ml.execute(add).getMatrix("y")
-     |   m.asRDDStringCSV.collect.foreach(println)
+     |   m.toRDDStringCSV.collect.foreach(println)
      |   add.in("x", m)
      | }
 #1:

http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/24f8c5e6/src/main/java/org/apache/sysml/api/mlcontext/Frame.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/sysml/api/mlcontext/Frame.java b/src/main/java/org/apache/sysml/api/mlcontext/Frame.java
index ee447df..c8c2c97 100644
--- a/src/main/java/org/apache/sysml/api/mlcontext/Frame.java
+++ b/src/main/java/org/apache/sysml/api/mlcontext/Frame.java
@@ -45,7 +45,7 @@ public class Frame {
 	 * 
 	 * @return the frame as a SystemML FrameObject
 	 */
-	public FrameObject asFrameObject() {
+	public FrameObject toFrameObject() {
 		return frameObject;
 	}
 
@@ -54,7 +54,7 @@ public class Frame {
 	 * 
 	 * @return the frame as a two-dimensional String array
 	 */
-	public String[][] as2DStringArray() {
+	public String[][] to2DStringArray() {
 		String[][] strArray = MLContextConversionUtil.frameObjectTo2DStringArray(frameObject);
 		return strArray;
 	}
@@ -64,7 +64,7 @@ public class Frame {
 	 * 
 	 * @return the frame as a {@code JavaRDD<String>} in IJV format
 	 */
-	public JavaRDD<String> asJavaRDDStringIJV() {
+	public JavaRDD<String> toJavaRDDStringIJV() {
 		JavaRDD<String> javaRDDStringIJV = MLContextConversionUtil.frameObjectToJavaRDDStringIJV(frameObject);
 		return javaRDDStringIJV;
 	}
@@ -74,7 +74,7 @@ public class Frame {
 	 * 
 	 * @return the frame as a {@code JavaRDD<String>} in CSV format
 	 */
-	public JavaRDD<String> asJavaRDDStringCSV() {
+	public JavaRDD<String> toJavaRDDStringCSV() {
 		JavaRDD<String> javaRDDStringCSV = MLContextConversionUtil.frameObjectToJavaRDDStringCSV(frameObject, ",");
 		return javaRDDStringCSV;
 	}
@@ -84,7 +84,7 @@ public class Frame {
 	 * 
 	 * @return the frame as a {@code RDD<String>} in CSV format
 	 */
-	public RDD<String> asRDDStringCSV() {
+	public RDD<String> toRDDStringCSV() {
 		RDD<String> rddStringCSV = MLContextConversionUtil.frameObjectToRDDStringCSV(frameObject, ",");
 		return rddStringCSV;
 	}
@@ -94,7 +94,7 @@ public class Frame {
 	 * 
 	 * @return the frame as a {@code RDD<String>} in IJV format
 	 */
-	public RDD<String> asRDDStringIJV() {
+	public RDD<String> toRDDStringIJV() {
 		RDD<String> rddStringIJV = MLContextConversionUtil.frameObjectToRDDStringIJV(frameObject);
 		return rddStringIJV;
 	}
@@ -104,7 +104,7 @@ public class Frame {
 	 * 
 	 * @return the frame as a {@code DataFrame}
 	 */
-	public DataFrame asDataFrame() {
+	public DataFrame toDF() {
 		DataFrame df = MLContextConversionUtil.frameObjectToDataFrame(frameObject, sparkExecutionContext);
 		return df;
 	}
@@ -114,7 +114,7 @@ public class Frame {
 	 * 
 	 * @return the matrix as a {@code BinaryBlockFrame}
 	 */
-	public BinaryBlockFrame asBinaryBlockFrame() {
+	public BinaryBlockFrame toBinaryBlockFrame() {
 		BinaryBlockFrame binaryBlockFrame = MLContextConversionUtil.frameObjectToBinaryBlockFrame(frameObject,
 				sparkExecutionContext);
 		return binaryBlockFrame;

http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/24f8c5e6/src/main/java/org/apache/sysml/api/mlcontext/MLContextConversionUtil.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/sysml/api/mlcontext/MLContextConversionUtil.java b/src/main/java/org/apache/sysml/api/mlcontext/MLContextConversionUtil.java
index b0f8432..9b15852 100644
--- a/src/main/java/org/apache/sysml/api/mlcontext/MLContextConversionUtil.java
+++ b/src/main/java/org/apache/sysml/api/mlcontext/MLContextConversionUtil.java
@@ -1295,7 +1295,7 @@ public class MLContextConversionUtil {
 	 *            the {@code MatrixObject}
 	 * @return the {@code MatrixObject} converted to a {@code double[][]}
 	 */
-	public static double[][] matrixObjectToDoubleMatrix(MatrixObject matrixObject) {
+	public static double[][] matrixObjectTo2DDoubleArray(MatrixObject matrixObject) {
 		try {
 			MatrixBlock mb = matrixObject.acquireRead();
 			double[][] matrix = DataConverter.convertToDoubleMatrix(mb);

http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/24f8c5e6/src/main/java/org/apache/sysml/api/mlcontext/MLContextUtil.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/sysml/api/mlcontext/MLContextUtil.java b/src/main/java/org/apache/sysml/api/mlcontext/MLContextUtil.java
index 566fba1..1331338 100644
--- a/src/main/java/org/apache/sysml/api/mlcontext/MLContextUtil.java
+++ b/src/main/java/org/apache/sysml/api/mlcontext/MLContextUtil.java
@@ -524,11 +524,11 @@ public final class MLContextUtil {
 			return frameObject;
 		} else if (value instanceof Matrix) {
 			Matrix matrix = (Matrix) value;
-			MatrixObject matrixObject = matrix.asMatrixObject();
+			MatrixObject matrixObject = matrix.toMatrixObject();
 			return matrixObject;
 		} else if (value instanceof Frame) {
 			Frame frame = (Frame) value;
-			FrameObject frameObject = frame.asFrameObject();
+			FrameObject frameObject = frame.toFrameObject();
 			return frameObject;
 		} else if (value instanceof double[][]) {
 			double[][] doubleMatrix = (double[][]) value;

http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/24f8c5e6/src/main/java/org/apache/sysml/api/mlcontext/MLResults.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/sysml/api/mlcontext/MLResults.java b/src/main/java/org/apache/sysml/api/mlcontext/MLResults.java
index d8446a9..5ae882f 100644
--- a/src/main/java/org/apache/sysml/api/mlcontext/MLResults.java
+++ b/src/main/java/org/apache/sysml/api/mlcontext/MLResults.java
@@ -142,7 +142,7 @@ public class MLResults {
 	 */
 	public double[][] getMatrixAs2DDoubleArray(String outputName) {
 		MatrixObject mo = getMatrixObject(outputName);
-		double[][] doubleMatrix = MLContextConversionUtil.matrixObjectToDoubleMatrix(mo);
+		double[][] doubleMatrix = MLContextConversionUtil.matrixObjectTo2DDoubleArray(mo);
 		return doubleMatrix;
 	}
 

http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/24f8c5e6/src/main/java/org/apache/sysml/api/mlcontext/Matrix.java
----------------------------------------------------------------------
diff --git a/src/main/java/org/apache/sysml/api/mlcontext/Matrix.java b/src/main/java/org/apache/sysml/api/mlcontext/Matrix.java
index abd785c..1e8e2eb 100644
--- a/src/main/java/org/apache/sysml/api/mlcontext/Matrix.java
+++ b/src/main/java/org/apache/sysml/api/mlcontext/Matrix.java
@@ -48,7 +48,7 @@ public class Matrix {
 	 * 
 	 * @return the matrix as a SystemML MatrixObject
 	 */
-	public MatrixObject asMatrixObject() {
+	public MatrixObject toMatrixObject() {
 		return matrixObject;
 	}
 
@@ -57,8 +57,8 @@ public class Matrix {
 	 * 
 	 * @return the matrix as a two-dimensional double array
 	 */
-	public double[][] asDoubleMatrix() {
-		double[][] doubleMatrix = MLContextConversionUtil.matrixObjectToDoubleMatrix(matrixObject);
+	public double[][] to2DDoubleArray() {
+		double[][] doubleMatrix = MLContextConversionUtil.matrixObjectTo2DDoubleArray(matrixObject);
 		return doubleMatrix;
 	}
 
@@ -67,7 +67,7 @@ public class Matrix {
 	 * 
 	 * @return the matrix as a {@code JavaRDD<String>} in IJV format
 	 */
-	public JavaRDD<String> asJavaRDDStringIJV() {
+	public JavaRDD<String> toJavaRDDStringIJV() {
 		JavaRDD<String> javaRDDStringIJV = MLContextConversionUtil.matrixObjectToJavaRDDStringIJV(matrixObject);
 		return javaRDDStringIJV;
 	}
@@ -77,7 +77,7 @@ public class Matrix {
 	 * 
 	 * @return the matrix as a {@code JavaRDD<String>} in CSV format
 	 */
-	public JavaRDD<String> asJavaRDDStringCSV() {
+	public JavaRDD<String> toJavaRDDStringCSV() {
 		JavaRDD<String> javaRDDStringCSV = MLContextConversionUtil.matrixObjectToJavaRDDStringCSV(matrixObject);
 		return javaRDDStringCSV;
 	}
@@ -87,7 +87,7 @@ public class Matrix {
 	 * 
 	 * @return the matrix as a {@code RDD<String>} in CSV format
 	 */
-	public RDD<String> asRDDStringCSV() {
+	public RDD<String> toRDDStringCSV() {
 		RDD<String> rddStringCSV = MLContextConversionUtil.matrixObjectToRDDStringCSV(matrixObject);
 		return rddStringCSV;
 	}
@@ -97,7 +97,7 @@ public class Matrix {
 	 * 
 	 * @return the matrix as a {@code RDD<String>} in IJV format
 	 */
-	public RDD<String> asRDDStringIJV() {
+	public RDD<String> toRDDStringIJV() {
 		RDD<String> rddStringIJV = MLContextConversionUtil.matrixObjectToRDDStringIJV(matrixObject);
 		return rddStringIJV;
 	}
@@ -107,7 +107,7 @@ public class Matrix {
 	 * 
 	 * @return the matrix as a {@code DataFrame} of doubles with an ID column
 	 */
-	public DataFrame asDataFrame() {
+	public DataFrame toDF() {
 		DataFrame df = MLContextConversionUtil.matrixObjectToDataFrame(matrixObject, sparkExecutionContext, false);
 		return df;
 	}
@@ -117,7 +117,7 @@ public class Matrix {
 	 * 
 	 * @return the matrix as a {@code DataFrame} of doubles with an ID column
 	 */
-	public DataFrame asDataFrameDoubleWithIDColumn() {
+	public DataFrame toDFDoubleWithIDColumn() {
 		DataFrame df = MLContextConversionUtil.matrixObjectToDataFrame(matrixObject, sparkExecutionContext, false);
 		return df;
 	}
@@ -127,7 +127,7 @@ public class Matrix {
 	 * 
 	 * @return the matrix as a {@code DataFrame} of doubles with no ID column
 	 */
-	public DataFrame asDataFrameDoubleNoIDColumn() {
+	public DataFrame toDFDoubleNoIDColumn() {
 		DataFrame df = MLContextConversionUtil.matrixObjectToDataFrame(matrixObject, sparkExecutionContext, false);
 		df = df.sort("ID").drop("ID");
 		return df;
@@ -138,7 +138,7 @@ public class Matrix {
 	 * 
 	 * @return the matrix as a {@code DataFrame} of vectors with an ID column
 	 */
-	public DataFrame asDataFrameVectorWithIDColumn() {
+	public DataFrame toDFVectorWithIDColumn() {
 		DataFrame df = MLContextConversionUtil.matrixObjectToDataFrame(matrixObject, sparkExecutionContext, true);
 		return df;
 	}
@@ -148,7 +148,7 @@ public class Matrix {
 	 * 
 	 * @return the matrix as a {@code DataFrame} of vectors with no ID column
 	 */
-	public DataFrame asDataFrameVectorNoIDColumn() {
+	public DataFrame toDFVectorNoIDColumn() {
 		DataFrame df = MLContextConversionUtil.matrixObjectToDataFrame(matrixObject, sparkExecutionContext, true);
 		df = df.sort("ID").drop("ID");
 		return df;
@@ -159,7 +159,7 @@ public class Matrix {
 	 * 
 	 * @return the matrix as a {@code BinaryBlockMatrix}
 	 */
-	public BinaryBlockMatrix asBinaryBlockMatrix() {
+	public BinaryBlockMatrix toBinaryBlockMatrix() {
 		BinaryBlockMatrix binaryBlockMatrix = MLContextConversionUtil.matrixObjectToBinaryBlockMatrix(matrixObject,
 				sparkExecutionContext);
 		return binaryBlockMatrix;

http://git-wip-us.apache.org/repos/asf/incubator-systemml/blob/24f8c5e6/src/main/python/systemml/mlcontext.py
----------------------------------------------------------------------
diff --git a/src/main/python/systemml/mlcontext.py b/src/main/python/systemml/mlcontext.py
index da8e025..389f9e1 100644
--- a/src/main/python/systemml/mlcontext.py
+++ b/src/main/python/systemml/mlcontext.py
@@ -124,7 +124,7 @@ class Matrix(object):
             DataFrames are unordered), followed by columns of doubles
             for each column in the matrix.
         """
-        jdf = self._java_matrix.asDataFrame()
+        jdf = self._java_matrix.toDF()
         df = _java2py(self.sc, jdf)
         return df
 
@@ -160,7 +160,7 @@ class MLResults(object):
         outputs: string, list of strings
             Output variables as defined inside the DML script.
         """
-        outs = [convertToNumpyArr(self.sc, self._java_results.getMatrix(out).asBinaryBlockMatrix().getMatrixBlock()) for out in outputs]
+        outs = [convertToNumpyArr(self.sc, self._java_results.getMatrix(out).toBinaryBlockMatrix().getMatrixBlock()) for out in outputs]
         if len(outs) == 1:
             return outs[0]
         return outs