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

Commit

Permalink
add fixes in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lanking520 committed Jan 25, 2019
1 parent 9021880 commit 447b821
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 10 deletions.
3 changes: 2 additions & 1 deletion docs/install/java_setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@ You can convert your existing Maven project to a project that can run in Eclipse
```
mvn eclipse:eclipse
```
This can be done once you have your maven project properly configured.

## Source

Expand All @@ -105,7 +106,7 @@ The previously mentioned setup with Maven is recommended. Otherwise, the followi


#### Build Java from an Existing MXNet Installation
If you have already built MXNet **from source** and are looking to setup Java from that point, you may simply run the following from the MXNet `scala-package`:
If you have already built MXNet **from source** and are looking to setup Java from that point, you may simply run the following from the MXNet `scala-package` folder:

```
mvn package
Expand Down
14 changes: 7 additions & 7 deletions scala-package/mxnet-demo/java-demo/README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# MXNet Java Sample Project
This is an project created to use Maven-published Scala/Java package with two Java examples.
## Setup
User are required to use maven to build the package, by simply running
You are required to use Maven to build the package with the following commands:
```
mvn package
```
This command will pick the default values specified in the pom file.
This command will pick the default values specified in the [pom](https://github.com/apache/incubator-mxnet/blob/master/scala-package/mxnet-demo/java-demo/pom.xml) file.

Note: If you are planning to use GPU, please add `-Dmxnet.profile=linux-x86_64-gpu`

### Use customized version set
You can use the following instruction as an alternative to achieve the same result:
User are required to use `mvn package` to build the package,
which are shown below:
You may use `mvn package` to build the package,
using the following commands:
```Bash
export SCALA_VERSION_PROFILE=2.11
export SCALA_PKG_PROFILE=
Expand Down Expand Up @@ -78,8 +78,8 @@ Clean up for Maven package is simple:
mvn clean
```

## Run in Eclipse
You can convert the maven project to the eclipse one by running
## Convert to Eclipse project (Optional)
You can convert the maven project to the eclipse one by running the following command:
```
mvn eclipse:eclipse
```
Expand All @@ -95,4 +95,4 @@ sudo apt install libopencv-imgcodecs3.4
Is there any other version available?

You can find nightly release version from [here](https://repository.apache.org/#nexus-search;gav~org.apache.mxnet~~1.5.0-SNAPSHOT~~).
Please keep the same version in the pom file or [above version](https://repository.apache.org/#nexus-search;gav~org.apache.mxnet~~~~) to run this demo.
Please keep the same version in the pom file or [other versions in here](https://repository.apache.org/#nexus-search;gav~org.apache.mxnet~~~~) to run this demo.
4 changes: 2 additions & 2 deletions scala-package/mxnet-demo/scala-demo/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# MXNet Scala Sample Project
This is an project created to use Maven-published Scala package with two Scala examples.
## Setup
User are required to use maven to build the package, by simply running
You are required to use maven to build the package, by running the following:
```
mvn package
```
Expand Down Expand Up @@ -55,7 +55,7 @@ If you want to test run on GPU, you can set a environment variable as follows:
export SCALA_TEST_ON_GPU=1
```
## Clean up
Clean up for Maven package is simple, you can just run
To clean up a Maven package, run the following:
```Bash
mvn clean
```
Expand Down

0 comments on commit 447b821

Please sign in to comment.