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

[MXNET-319][DO NOT MERGE][Deprecated] Javadoc fix #11123

Closed
wants to merge 36 commits into from

Conversation

lanking520
Copy link
Member

@lanking520 lanking520 commented Jun 1, 2018

Description

This is an experimental PR used to find a best way to generate Javadoc for Scala
@nswamy @yzhliu
Here are two solution I proposed:

  1. use new API signature to replace the old one (this PR)
  2. create signature for old api and not change the current functions

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)

Comments

  • If this change is a backward incompatible change, why must this change be made.
  • Interesting edge cases to note here

@lanking520 lanking520 requested a review from yzhliu as a code owner June 1, 2018 17:39
@lanking520
Copy link
Member Author

Since this is a risky decision to work on this way, I will close this once we have NDArray bug fix merged. There will be another PR for Documentation with Signature for all old APIs.

@andrewfayres
Copy link
Contributor

commenting to see if this fixes the problem with you tagging me on this

@lanking520
Copy link
Member Author

@andrewfayres Thanks!

@lanking520 lanking520 mentioned this pull request Jun 4, 2018
5 tasks
@yzhliu yzhliu changed the title [MXNET-319][WIP] Javadoc fix [MXNET-319][WIP] Javadoc fix (Proposal 1) Jun 5, 2018
@yzhliu yzhliu changed the title [MXNET-319][WIP] Javadoc fix (Proposal 1) [MXNET-319][WIP] Javadoc fix (Approach 1) Jun 5, 2018
@yzhliu yzhliu changed the title [MXNET-319][WIP] Javadoc fix (Approach 1) [MXNET-319][DO NOT MERGE][Deprecated] Javadoc fix Jun 5, 2018
@lanking520 lanking520 mentioned this pull request Jun 12, 2018
5 tasks
@nswamy
Copy link
Member

nswamy commented Jun 12, 2018

@lanking520 Can we close this, as discussed in another PR we agreed not to change the internal APIs to use new APIs?

@lanking520
Copy link
Member Author

Master branch merged, no need to go with this solution

@lanking520 lanking520 closed this Jun 13, 2018
@lanking520 lanking520 deleted the javadoc-fix2 branch June 13, 2018 18:28
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

3 participants