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

Initial website documentation for Java API #13289

Merged
merged 10 commits into from
Nov 25, 2018
Merged

Conversation

andrewfayres
Copy link
Contributor

@andrewfayres andrewfayres commented Nov 15, 2018

Description

This is the first pass at creating the website documentation needed for the new Java API release.

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-13289/10/index.html
    http://mxnet-ci-doc.s3-accelerate.dualstack.amazonaws.com/PR-13289/10/install/java_setup.html
  • To the my best knowledge, examples are either not affected by this change, or have been fixed to be compatible with this change

@kalyc
Copy link
Contributor

kalyc commented Nov 16, 2018

@mxnet-label-bot add [pr-awaiting-review]

@marcoabreu marcoabreu added the pr-awaiting-review PR is waiting for code review label Nov 16, 2018
@kalyc
Copy link
Contributor

kalyc commented Nov 16, 2018

@andrewfayres thanks for your contribution! Have these instructions been tested locally?

docs/api/java/index.md Outdated Show resolved Hide resolved
docs/api/java/index.md Show resolved Hide resolved
@@ -0,0 +1,111 @@
# Setup the MXNet Package for Java
Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Will add new link once build finishes

docs/install/java_setup.md Show resolved Hide resolved
docs/install/java_setup.md Outdated Show resolved Hide resolved
docs/install/java_setup.md Outdated Show resolved Hide resolved
docs/install/java_setup.md Show resolved Hide resolved
docs/install/java_setup.md Outdated Show resolved Hide resolved
@aaronmarkham
Copy link
Contributor

In addition to my previous comments, let's handle the tutorials main index page and the API navigation in one step.

Let me know if I can assist.

@andrewfayres
Copy link
Contributor Author

I think I've addressed all feedback. As soon as the build finishes and we get the preview version I'll update the links and double check everything.

Copy link
Contributor

@aaronmarkham aaronmarkham left a comment

Choose a reason for hiding this comment

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

LGTM... please review the preview when it finishes though.

Copy link
Member

@lanking520 lanking520 left a comment

Choose a reason for hiding this comment

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

@andrewfayres Please confirm this before we merge it.

docs/install/java_setup.md Outdated Show resolved Hide resolved
Copy link
Member

@lanking520 lanking520 left a comment

Choose a reason for hiding this comment

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

LGTM

@lanking520 lanking520 merged commit d412f4f into apache:master Nov 25, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
pr-awaiting-review PR is waiting for code review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants