forked from apache/mxnet
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[MXNET-386] API Docs Generation (apache#10991)
API Docs Generation (apache#10991)
- Loading branch information
1 parent
3e6067d
commit b5e682d
Showing
11 changed files
with
262 additions
and
128 deletions.
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
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
141 changes: 141 additions & 0 deletions
141
scala-package/macros/src/main/scala/org/apache/mxnet/APIDocGenerator.scala
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 |
|---|---|---|
| @@ -0,0 +1,141 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to You under the Apache License, Version 2.0 | ||
| * (the "License"); you may not use this file except in compliance with | ||
| * the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package org.apache.mxnet | ||
|
|
||
| import org.apache.mxnet.init.Base._ | ||
| import org.apache.mxnet.utils.CToScalaUtils | ||
|
|
||
| import scala.collection.mutable.ListBuffer | ||
|
|
||
| /** | ||
| * This object will generate the Scala documentation of the new Scala API | ||
| * Two file namely: SymbolAPIBase.scala and NDArrayAPIBase.scala | ||
| * The code will be executed during Macros stage and file live in Core stage | ||
| */ | ||
| private[mxnet] object APIDocGenerator{ | ||
| case class absClassArg(argName : String, argType : String, argDesc : String, isOptional : Boolean) | ||
| case class absClassFunction(name : String, desc : String, | ||
| listOfArgs: List[absClassArg], returnType : String) | ||
|
|
||
|
|
||
| def main(args: Array[String]) : Unit = { | ||
| val FILE_PATH = args(0) | ||
| absClassGen(FILE_PATH, true) | ||
| absClassGen(FILE_PATH, false) | ||
| } | ||
|
|
||
| def absClassGen(FILE_PATH : String, isSymbol : Boolean) : Unit = { | ||
| // scalastyle:off | ||
| val absClassFunctions = getSymbolNDArrayMethods(isSymbol) | ||
| // TODO: Add Filter to the same location in case of refactor | ||
| val absFuncs = absClassFunctions.filterNot(_.name.startsWith("_")).map(absClassFunction => { | ||
| val scalaDoc = generateAPIDocFromBackend(absClassFunction) | ||
| val defBody = generateAPISignature(absClassFunction, isSymbol) | ||
| s"$scalaDoc\n$defBody" | ||
| }) | ||
| val packageName = if (isSymbol) "SymbolAPIBase" else "NDArrayAPIBase" | ||
| val apacheLicence = "/*\n* Licensed to the Apache Software Foundation (ASF) under one or more\n* contributor license agreements. See the NOTICE file distributed with\n* this work for additional information regarding copyright ownership.\n* The ASF licenses this file to You under the Apache License, Version 2.0\n* (the \"License\"); you may not use this file except in compliance with\n* the License. You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n" | ||
| val scalaStyle = "// scalastyle:off" | ||
| val packageDef = "package org.apache.mxnet" | ||
| val absClassDef = s"abstract class $packageName" | ||
| val finalStr = s"$apacheLicence\n$scalaStyle\n$packageDef\n$absClassDef {\n${absFuncs.mkString("\n")}\n}" | ||
| import java.io._ | ||
| val pw = new PrintWriter(new File(FILE_PATH + s"$packageName.scala")) | ||
| pw.write(finalStr) | ||
| pw.close() | ||
| } | ||
|
|
||
| // Generate ScalaDoc type | ||
| def generateAPIDocFromBackend(func : absClassFunction) : String = { | ||
| val desc = func.desc.split("\n").map({ currStr => | ||
| s" * $currStr" | ||
| }) | ||
| val params = func.listOfArgs.map({ absClassArg => | ||
| val currArgName = absClassArg.argName match { | ||
| case "var" => "vari" | ||
| case "type" => "typeOf" | ||
| case _ => absClassArg.argName | ||
| } | ||
| s" * @param $currArgName\t\t${absClassArg.argDesc}" | ||
| }) | ||
| val returnType = s" * @return ${func.returnType}" | ||
| s" /**\n${desc.mkString("\n")}\n${params.mkString("\n")}\n$returnType\n */" | ||
| } | ||
|
|
||
| def generateAPISignature(func : absClassFunction, isSymbol : Boolean) : String = { | ||
| var argDef = ListBuffer[String]() | ||
| func.listOfArgs.foreach(absClassArg => { | ||
| val currArgName = absClassArg.argName match { | ||
| case "var" => "vari" | ||
| case "type" => "typeOf" | ||
| case _ => absClassArg.argName | ||
| } | ||
| if (absClassArg.isOptional) { | ||
| argDef += s"$currArgName : Option[${absClassArg.argType}] = None" | ||
| } | ||
| else { | ||
| argDef += s"$currArgName : ${absClassArg.argType}" | ||
| } | ||
| }) | ||
| var returnType = func.returnType | ||
| if (isSymbol) { | ||
| argDef += "name : String = null" | ||
| argDef += "attr : Map[String, String] = null" | ||
| } else { | ||
| returnType = "org.apache.mxnet.NDArrayFuncReturn" | ||
| } | ||
| s"def ${func.name} (${argDef.mkString(", ")}) : ${returnType}" | ||
| } | ||
|
|
||
|
|
||
| // List and add all the atomic symbol functions to current module. | ||
| private def getSymbolNDArrayMethods(isSymbol : Boolean): List[absClassFunction] = { | ||
| val opNames = ListBuffer.empty[String] | ||
| val returnType = if (isSymbol) "Symbol" else "NDArray" | ||
| _LIB.mxListAllOpNames(opNames) | ||
| // TODO: Add '_linalg_', '_sparse_', '_image_' support | ||
| opNames.map(opName => { | ||
| val opHandle = new RefLong | ||
| _LIB.nnGetOpHandle(opName, opHandle) | ||
| makeAtomicSymbolFunction(opHandle.value, opName, "org.apache.mxnet." + returnType) | ||
| }).toList | ||
| } | ||
|
|
||
| // Create an atomic symbol function by handle and function name. | ||
| private def makeAtomicSymbolFunction(handle: SymbolHandle, aliasName: String, returnType : String) | ||
| : absClassFunction = { | ||
| val name = new RefString | ||
| val desc = new RefString | ||
| val keyVarNumArgs = new RefString | ||
| val numArgs = new RefInt | ||
| val argNames = ListBuffer.empty[String] | ||
| val argTypes = ListBuffer.empty[String] | ||
| val argDescs = ListBuffer.empty[String] | ||
|
|
||
| _LIB.mxSymbolGetAtomicSymbolInfo( | ||
| handle, name, desc, numArgs, argNames, argTypes, argDescs, keyVarNumArgs) | ||
|
|
||
| val realName = if (aliasName == name.value) "" else s"(a.k.a., ${name.value})" | ||
|
|
||
| val argList = argNames zip argTypes zip argDescs map { case ((argName, argType), argDesc) => | ||
| val typeAndOption = CToScalaUtils.argumentCleaner(argType, returnType) | ||
| new absClassArg(argName, typeAndOption._1, argDesc, typeAndOption._2) | ||
| } | ||
| new absClassFunction(aliasName, desc.value, argList.toList, returnType) | ||
| } | ||
| } |
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
Oops, something went wrong.