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

[MXNET-1226] add Docs update for MXNet Java #14395

Merged
merged 4 commits into from
Mar 13, 2019

Conversation

lanking520
Copy link
Member

Description

Add Java docs update with 1.4.0
@piyushghai @andrewfayres @aaronmarkham

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 https://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

@lanking520 lanking520 requested a review from szha as a code owner March 11, 2019 22:53
@@ -35,21 +35,15 @@ The following instructions are provided for macOS and Ubuntu. Windows is not yet
brew update
brew tap caskroom/versions
brew cask install java8
brew install opencv
Copy link
Contributor

Choose a reason for hiding this comment

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

What's going on here?

Copy link
Member Author

Choose a reason for hiding this comment

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

We don't need to install openCV for Java, not any more

docs/tutorials/java/mxnet_java_on_intellij.md Outdated Show resolved Hide resolved
docs/tutorials/java/mxnet_java_on_intellij.md Outdated Show resolved Hide resolved
docs/install/java_setup.md Outdated Show resolved Hide resolved

```bash
wget https://raw.githubusercontent.com/apache/incubator-mxnet/master/ci/docker/install/ubuntu_core.sh
Copy link
Contributor

Choose a reason for hiding this comment

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

So all of the dependencies for ubuntu/scala/mxnet environment are covered with this change? I'm skeptical.

Copy link
Member Author

Choose a reason for hiding this comment

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

We no longer require user to install that bunch... Simply Java and maven would work

@karan6181
Copy link
Contributor

@mxnet-label-bot add [Java, Doc]

@marcoabreu marcoabreu added Doc Java Label to identify Java API component labels Mar 12, 2019
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

docs/install/java_setup.md Outdated Show resolved Hide resolved
docs/tutorials/java/mxnet_java_on_intellij.md Outdated Show resolved Hide resolved
@lanking520 lanking520 merged commit 4432af1 into apache:master Mar 13, 2019
vdantu pushed a commit to vdantu/incubator-mxnet that referenced this pull request Mar 31, 2019
* add Docs update for MXNet Java

* fixed based on comments

* Update docs/install/java_setup.md

Co-Authored-By: lanking520 <[email protected]>

* Update docs/tutorials/java/mxnet_java_on_intellij.md

Co-Authored-By: lanking520 <[email protected]>
nswamy pushed a commit that referenced this pull request Apr 5, 2019
* add Docs update for MXNet Java

* fixed based on comments

* Update docs/install/java_setup.md

Co-Authored-By: lanking520 <[email protected]>

* Update docs/tutorials/java/mxnet_java_on_intellij.md

Co-Authored-By: lanking520 <[email protected]>
@lanking520 lanking520 deleted the 1.4.0doc branch June 21, 2019 22:11
haohuanw pushed a commit to haohuanw/incubator-mxnet that referenced this pull request Jun 23, 2019
* add Docs update for MXNet Java

* fixed based on comments

* Update docs/install/java_setup.md

Co-Authored-By: lanking520 <[email protected]>

* Update docs/tutorials/java/mxnet_java_on_intellij.md

Co-Authored-By: lanking520 <[email protected]>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Doc Java Label to identify Java API component
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants