This repository has been archived by the owner on Nov 17, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 6.8k
[MXNET-1202] Change Builder class to use Parameter Builder Object for APIs that have more than 3 optional arguments #13159
Merged
Merged
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
b8ac3a4
applying changes for Builder functions
lanking520 9d2ff22
simplify the code structure
lanking520 274fcd9
update docgen
lanking520 1f7e1e6
follow Naveen's suggestion
lanking520 7a8892c
apply comments to Param
lanking520 fc20282
clean up param build
lanking520 65105a7
change on the comments
lanking520 19088d6
add one description line
lanking520 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -116,9 +116,7 @@ private[mxnet] object APIDocGenerator{ | |
val absFuncs = absClassFunctions.filterNot(_.name.startsWith("_")) | ||
.filterNot(ele => notGenerated.contains(ele.name)) | ||
.map(absClassFunction => { | ||
val scalaDoc = generateAPIDocFromBackend(absClassFunction) | ||
val defBody = generateJavaAPISignature(absClassFunction) | ||
s"$scalaDoc\n$defBody" | ||
generateJavaAPISignature(absClassFunction) | ||
}) | ||
val packageName = "NDArrayBase" | ||
val packageDef = "package org.apache.mxnet.javaapi" | ||
|
@@ -203,27 +201,61 @@ 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]() | ||
var requiredParam = 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"""private var $currArgName: ${absClassArg.argType} = null | ||
|/** | ||
| * @param $currArgName\t\t${absClassArg.argDesc} | ||
| */ | ||
|def set${currArgName.capitalize}($currArgName : ${absClassArg.argType}): ${func.name}Param = { | ||
| this.$currArgName = $currArgName | ||
| this | ||
| }""".stripMargin | ||
} | ||
else { | ||
requiredParam += s" * @param $currArgName\t\t${absClassArg.argDesc}" | ||
argDef += s"$currArgName : ${absClassArg.argType}" | ||
} | ||
classDef += s"def get${currArgName.capitalize}() = this.$currArgName" | ||
// 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 = "Array[NDArray]" | ||
val scalaDoc = generateAPIDocFromBackend(func) | ||
val scalaDocNoParam = generateAPIDocFromBackend(func, false) | ||
if(useParamObject) { | ||
classDef += | ||
s"""private var out : org.apache.mxnet.NDArray = null | ||
|def setOut(out : NDArray) : ${func.name}Param = { | ||
| this.out = out | ||
| this | ||
| } | ||
| def getOut() = this.out | ||
| """.stripMargin | ||
s"""$scalaDocNoParam | ||
| $experimentalTag | ||
| def ${func.name}(po: ${func.name}Param) : $returnType | ||
| /** | ||
| * This Param Object is specifically used for ${func.name} | ||
| ${requiredParam.mkString("\n")} | ||
| */ | ||
| class ${func.name}Param(${argDef.mkString(",")}) { | ||
| ${classDef.mkString("\n ")} | ||
| }""".stripMargin | ||
} else { | ||
argDef += "out : NDArray" | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. It takes the Java one |
||
s"""$scalaDoc | ||
|$experimentalTag | ||
| def ${func.name}(${argDef.mkString(", ")}) : $returnType | ||
| """.stripMargin | ||
} | ||
} | ||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nitpick: The spacing is off in the generated code for the comments and the def. If you push any other change please add indention here.