Skip to content
This repository has been archived by the owner on Nov 17, 2023. It is now read-only.

[MXNET-1202] Change Builder class to use Parameter Builder Object for APIs that have more than 3 optional arguments #13159

Merged
merged 8 commits into from
Nov 12, 2018
Merged

[MXNET-1202] Change Builder class to use Parameter Builder Object for APIs that have more than 3 optional arguments #13159

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
b8ac3a4
applying changes for Builder functions
lanking520 Nov 7, 2018
9d2ff22
simplify the code structure
lanking520 Nov 8, 2018
274fcd9
update docgen
lanking520 Nov 9, 2018
1f7e1e6
follow Naveen's suggestion
lanking520 Nov 9, 2018
7a8892c
apply comments to Param
lanking520 Nov 9, 2018
fc20282
clean up param build
lanking520 Nov 10, 2018
65105a7
change on the comments
lanking520 Nov 10, 2018
19088d6
add one description line
lanking520 Nov 12, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions scala-package/core/src/test/java/org/apache/mxnet/javaapi/NDArrayTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@

import org.junit.Test;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import org.apache.mxnet.javaapi.NDArray.*;

import static org.junit.Assert.assertTrue;

Expand Down Expand Up @@ -71,15 +71,15 @@ public void testGenerated(){
NDArray$ NDArray = NDArray$.MODULE$;
float[] arr = new float[]{1.0f, 2.0f, 3.0f};
NDArray nd = new NDArray(arr, new Shape(new int[]{3}), new Context("cpu", 0));
float result = NDArray.norm(nd).invoke().get().toArray()[0];
float result = NDArray.norm(new normParam(nd)).get().toArray()[0];
float cal = 0.0f;
for (float ele : arr) {
cal += ele * ele;
}
cal = (float) Math.sqrt(cal);
assertTrue(Math.abs(result - cal) < 1e-5);
NDArray dotResult = new NDArray(new float[]{0}, new Shape(new int[]{1}), new Context("cpu", 0));
NDArray.dot(nd, nd).setout(dotResult).invoke().get();
NDArray.dot(new dotParam(nd, nd).setOut(dotResult)).get();
assertTrue(Arrays.equals(dotResult.toArray(), new float[]{14.0f}));
}
}
27 changes: 18 additions & 9 deletions scala-package/macros/src/main/scala/org/apache/mxnet/APIDocGenerator.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -203,27 +203,36 @@ private[mxnet] object APIDocGenerator{
}

def generateJavaAPISignature(func : absClassFunction) : String = {
val useParamObject = func.listOfArgs.count(arg => arg.isOptional) >= 2
var argDef = ListBuffer[String]()
var classDef = ListBuffer[String]()
func.listOfArgs.foreach(absClassArg => {
val currArgName = safetyNameCheck(absClassArg.argName)
// scalastyle:off
if (absClassArg.isOptional) {
classDef += s"def set${absClassArg.argName}(${absClassArg.argName} : ${absClassArg.argType}) : ${func.name}BuilderBase"
if (absClassArg.isOptional && useParamObject) {
classDef += s"def set${absClassArg.argName.capitalize}(${absClassArg.argName}: ${absClassArg.argType}): ${func.name}ParamBase"
}
else {
argDef += s"$currArgName : ${absClassArg.argType}"
}
// scalastyle:on
})
classDef += s"def setout(out : NDArray) : ${func.name}BuilderBase"
classDef += s"def invoke() : org.apache.mxnet.javaapi.NDArrayFuncReturn"
val experimentalTag = "@Experimental"
// scalastyle:off
var finalStr = s"$experimentalTag\ndef ${func.name} (${argDef.mkString(", ")}) : ${func.name}BuilderBase\n"
// scalastyle:on
finalStr += s"abstract class ${func.name}BuilderBase {\n ${classDef.mkString("\n ")}\n}"
finalStr
val returnType = "org.apache.mxnet.javaapi.NDArrayFuncReturn"
if(useParamObject) {
classDef += s"def setOut(out : NDArray) : ${func.name}ParamBase"
classDef += s"def invoke() : $returnType"
s"""$experimentalTag
| def ${func.name}(po: ${func.name}ParamBase) : $returnType
| abstract class ${func.name}ParamBase(${argDef.mkString(",")}) {
| ${classDef.mkString("\n ")}
| }""".stripMargin
} else {
argDef += "out : NDArray"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

which NDArray does it take? javaapi.NDArray or mxnet.NDArray? shouldn't this take the java one?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It takes the Java one

s"""$experimentalTag
| def ${func.name}(${argDef.mkString(", ")}) : $returnType
| """.stripMargin
}
}


Expand Down
66 changes: 43 additions & 23 deletions scala-package/macros/src/main/scala/org/apache/mxnet/javaapi/JavaNDArrayMacro.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,16 +68,17 @@ private[mxnet] object JavaNDArrayMacro {

newNDArrayFunctions.foreach { ndarrayfunction =>

val useParamObject = ndarrayfunction.listOfArgs.count(arg => arg.isOptional) >= 2
val header = if (useParamObject) "this." else ""
// Construct argument field with all required args
var argDef = ListBuffer[String]()
// Construct Optional Arg
var OptionArgDef = ListBuffer[String]()
// Construct function Implementation field (e.g norm)
var impl = ListBuffer[String]()
impl += "val map = scala.collection.mutable.Map[String, Any]()"
// scalastyle:off
impl += "val args= scala.collection.mutable.ArrayBuffer.empty[org.apache.mxnet.NDArray]"
// scalastyle:on
impl +=
"val args= scala.collection.mutable.ArrayBuffer.empty[org.apache.mxnet.NDArray]"
// Construct Class Implementation (e.g normBuilder)
var classImpl = ListBuffer[String]()
ndarrayfunction.listOfArgs.foreach({ ndarrayArg =>
Expand All @@ -88,9 +89,9 @@ private[mxnet] object JavaNDArrayMacro {
case "type" => "typeOf"
case _ => ndarrayArg.argName
}
if (ndarrayArg.isOptional) {
if (ndarrayArg.isOptional && useParamObject) {
OptionArgDef += s"private var $currArgName : ${ndarrayArg.argType} = null"
val tempDef = s"def set$currArgName($currArgName : ${ndarrayArg.argType})"
val tempDef = s"def set${currArgName.capitalize}($currArgName : ${ndarrayArg.argType})"
val tempImpl = s"this.$currArgName = $currArgName\nthis"
classImpl += s"$tempDef = {$tempImpl}"
} else {
Expand All @@ -100,35 +101,54 @@ private[mxnet] object JavaNDArrayMacro {
val returnType = "org.apache.mxnet.javaapi.NDArray"
val base =
if (ndarrayArg.argType.equals(returnType)) {
s"args += this.$currArgName"
s"args += $header$currArgName"
} else if (ndarrayArg.argType.equals(s"Array[$returnType]")){
s"this.$currArgName.foreach(args+=_)"
s"$header$currArgName.foreach(args+=_)"
} else {
"map(\"" + ndarrayArg.argName + "\") = this." + currArgName
"map(\"" + ndarrayArg.argName + "\") = " + header + currArgName
}
impl.append(
if (ndarrayArg.isOptional) s"if (this.$currArgName != null) $base"
if (ndarrayArg.isOptional) s"if ($header$currArgName != null) $base"
else base
)
})
// add default out parameter
classImpl +=
"def setout(out : org.apache.mxnet.javaapi.NDArray) = {this.out = out\nthis}"
impl += "if (this.out != null) map(\"out\") = this.out"
OptionArgDef += "private var out : org.apache.mxnet.NDArray = null"
if (useParamObject) {
classImpl +=
"def setOut(out : org.apache.mxnet.javaapi.NDArray) = {this.out = out\nthis}"
} else {
argDef += s"out: org.apache.mxnet.javaapi.NDArray"
}
impl += "if (" + header + "out != null) map(\"out\") = " + header + "out"
OptionArgDef += "var out : org.apache.mxnet.NDArray = null"
val returnType = "org.apache.mxnet.javaapi.NDArrayFuncReturn"
// scalastyle:off
// Combine and build the function string
impl += "org.apache.mxnet.NDArray.genericNDArrayFunctionInvoke(\"" + ndarrayfunction.name + "\", args.toSeq, map.toMap)"
val classDef = s"class ${ndarrayfunction.name}Builder(${argDef.mkString(",")}) extends ${ndarrayfunction.name}BuilderBase"
val classBody = s"${OptionArgDef.mkString("\n")}\n${classImpl.mkString("\n")}\ndef invoke() : $returnType = {${impl.mkString("\n")}}"
val classFinal = s"$classDef {$classBody}"
val functionDef = s"def ${ndarrayfunction.name} (${argDef.mkString(",")})"
val functionBody = s"new ${ndarrayfunction.name}Builder(${argDef.map(_.split(":")(0)).mkString(",")})"
val functionFinal = s"$functionDef : ${ndarrayfunction.name}BuilderBase = $functionBody"
// scalastyle:on
functionDefs += c.parse(functionFinal).asInstanceOf[DefDef]
classDefs += c.parse(classFinal).asInstanceOf[ClassDef]
impl += "org.apache.mxnet.NDArray.genericNDArrayFunctionInvoke(\"" +
ndarrayfunction.name + "\", args.toSeq, map.toMap)"
if (useParamObject) {
val classDef =
s"""class ${ndarrayfunction.name}Param(${argDef.mkString(",")})
| extends ${ndarrayfunction.name}ParamBase(${argDef.mkString(",")}) {
| ${OptionArgDef.mkString("\n")}
| ${classImpl.mkString("\n")}
| def invoke() : $returnType = {
| ${impl.mkString("\n")}
| }
| }""".stripMargin
classDefs += c.parse(classDef).asInstanceOf[ClassDef]
val funcDef =
s"""def ${ndarrayfunction.name}(po: ${ndarrayfunction.name}ParamBase): $returnType = {
| po.invoke()
| }""".stripMargin
functionDefs += c.parse(funcDef).asInstanceOf[DefDef]
} else {
val funcDef =
s"""def ${ndarrayfunction.name}(${argDef.mkString(",")}): $returnType = {
| ${impl.mkString("\n")}
| }""".stripMargin
functionDefs += c.parse(funcDef).asInstanceOf[DefDef]
}
}

structGeneration(c)(functionDefs.toList, classDefs.toList, annottees : _*)
Expand Down