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

[MXNET-319] [WIP] Add Autocomplete Macros in Scala #10546

Closed
wants to merge 6 commits into from

Conversation

lanking520
Copy link
Member

@lanking520 lanking520 commented Apr 13, 2018

Description

Add SymbolBaseMacros File: It will generate a SymbolBase trait with full documentation on the Symbol APIs. Also enable the "return_type" Parameters that will be helpful to generate the docs.

@nswamy @yzhliu @Roshrini

Checklist

Essentials

Please feel free to remove inapplicable items for your PR.

  • The PR title starts with [MXNET-$JIRA_ID], where $JIRA_ID refers to the relevant JIRA issue created (except PRs with tiny changes)
  • Changes are complete (i.e. I finished coding on this PR)
  • All changes have test coverage:
  • Unit tests are added for small changes to verify correctness (e.g. adding a new operator)
  • Nightly tests are added for complicated/long-running ones (e.g. changing distributed kvstore)
  • Build tests will be added for build configuration changes (e.g. adding a new build option with NCCL)
  • Code is well-documented:
  • For user-facing API changes, API doc string has been updated.
  • For new C++ functions in header files, their functionalities and arguments are documented.
  • For new examples, README.md is added to explain the what the example does, the source of the dataset, expected performance on test set and reference to the original paper if applicable
  • Check the API doc at http://mxnet-ci-doc.s3-accelerate.dualstack.amazonaws.com/PR-$PR_ID/$BUILD_ID/index.html
  • To the my best knowledge, examples are either not affected by this change, or have been fixed to be compatible with this change

Changes

  • Feature1, tests, (and when applicable, API doc)
  • Feature2, tests, (and when applicable, API doc)

@lanking520 lanking520 requested a review from yzhliu as a code owner April 13, 2018 18:36
import scala.collection.mutable.{HashMap, ListBuffer}
import org.apache.mxnet.init.Base._


Copy link
Member

Choose a reason for hiding this comment

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

Add comments explaining the functionality of this macro

}
// scalastyle:off
val defaultConfig = s"(name : scala.Predef.String, attr : scala.Predef.Map[scala.Predef.String, scala.Predef.String])(args : org.apache.mxnet.Symbol*)(kwargs : scala.Predef.Map[scala.Predef.String, scala.Any]) : org.apache.mxnet.Symbol"
// s"/**\n${desc.mkString("\n")}\n${params.mkString("\n")}\n* @return $returnType\n*/\ndef $functionName(${traitsec.mkString(", ")}) : Any"
Copy link
Member

Choose a reason for hiding this comment

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

Remove comments

typeConv = typeMap(commaRemoved(0))
}
// if (!typeMap.contains(commaRemoved(0))) {
// logger.error("First Field not recognized " + commaRemoved(0))
Copy link
Member

Choose a reason for hiding this comment

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

Remove commented lines

@lanking520
Copy link
Member Author

Tested with make docs. The Function definitions were successfully generated on Scala docs

@nswamy nswamy changed the title [MXNET-319] Add Autocomplete Macros in Scala [MXNET-319] [WIP] Add Autocomplete Macros in Scala Apr 19, 2018
@lanking520 lanking520 closed this May 17, 2018
@lanking520
Copy link
Member Author

Close this PR since it is outdated and duplicated with the new one: #10991

@lanking520 lanking520 deleted the autocomplete branch May 18, 2018 22:45
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants