This repository has been archived by the owner on Nov 17, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 6.8k
some minor typos/clarifications #15538
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -18,24 +18,24 @@ | |||||
MXNet Package for Scala/Java | ||||||
===== | ||||||
|
||||||
The MXNet Scala/Java Package brings flexible and efficient GPU/CPU computing and state-of-art deep learning to JVM. | ||||||
The MXNet Scala/Java Package brings flexible and efficient GPU/CPU computing and state-of-art deep learning to the JVM. | ||||||
|
||||||
- It enables you to write seamless tensor/matrix computation with multiple GPUs | ||||||
in Scala, Java and other languages built on JVM. | ||||||
in Scala, Java and other JVM languages. | ||||||
- It also enables you to construct and customize the state-of-art deep learning models in JVM languages, | ||||||
and apply them to tasks such as image classification and data science challenges. | ||||||
- The Scala/Java Inferece APIs provides an easy out of the box solution for loading pre-trained MXNet models and running inference on them. | ||||||
- The Scala/Java _Inference API_ provides an easy out of the box solution for performing inference tasks using pre-trained MXNet models. | ||||||
|
||||||
Pre-Built Maven Packages | ||||||
------------------------ | ||||||
|
||||||
### Stable ### | ||||||
|
||||||
The MXNet Scala/Java packages can be easily included in your Maven managed project. | ||||||
The stable jar files for the packages are available on the [MXNet Maven Package Repository](https://search.maven.org/search?q=g:org.apache.mxnet) | ||||||
The stable jar files for the packages are available on the [MXNet Maven Package Repository](https://search.maven.org/search?q=g:org.apache.mxnet). | ||||||
Currently we provide packages for Linux (Ubuntu 16.04) (CPU and GPU) and macOS (CPU only). Stable packages for Windows and CentOS will come soon. For now, if you have a CentOS machine, follow the ```Build From Source``` section below. | ||||||
|
||||||
To add MXNet Scala/Java package to your project, add the dependency as shown below corresponding to your platform, under the ```dependencies``` tag in your project's ```pom.xml``` : | ||||||
To add the MXNet Scala/Java packages to your project, add the dependency as shown below corresponding to your platform, under the ```dependencies``` tag in your project's ```pom.xml``` : | ||||||
|
||||||
**Linux GPU** | ||||||
|
||||||
|
@@ -77,7 +77,7 @@ To add MXNet Scala/Java package to your project, add the dependency as shown bel | |||||
|
||||||
### Nightly ### | ||||||
|
||||||
Apart from these, the nightly builds representing the bleeding edge development on Scala/Java packages are also available on the [MXNet Maven Nexus Package Repository](https://repository.apache.org/#nexus-search;gav~org.apache.mxnet~~~~). | ||||||
Apart from these, the nightly builds representing the bleeding edge development on Scala/Java packages are also available on the [MXNet Maven Nexus Package Repository](https://repository.apache.org/#nexus-search;gav~org.apache.mxnet~~~~). | ||||||
Currently we provide nightly packages for Linux (CPU and GPU) and MacOS (CPU only). The Linux nightly jar files also work on CentOS. Nightly packages for Windows will come soon. | ||||||
|
||||||
Add the following ```repository``` to your project's ```pom.xml``` file : | ||||||
|
@@ -133,8 +133,8 @@ Also, add the dependency which corresponds to your platform to the ```dependenci | |||||
Build From Source | ||||||
----------------- | ||||||
|
||||||
Checkout the [Installation Guide](http://mxnet.incubator.apache.org/install/index.html) contains instructions to install mxnet package and build it from source. Scala maven build assume you already have a ``lib/libmxnet.so`` file. | ||||||
If you have built MXNet from source and are looking to setup Scala from that point, you may simply run the following from the MXNet source root, Scala build will detect your platform (OSX/Linux) and libmxnet.so flavor (CPU/GPU): | ||||||
The [Installation Guide](http://mxnet.incubator.apache.org/install/index.html) contains instructions to install mxnet or build it from source. The Scala/Java package is built from source using Maven. The maven build assumes you already have a ``lib/libmxnet.so`` file. | ||||||
If you have built MXNet from source and are looking to set up Scala\Java from that point, you may simply run the following from the MXNet source root, the build will detect your platform (OSX/Linux) and libmxnet.so flavor (CPU/GPU): | ||||||
|
||||||
```bash | ||||||
cd scala-package | ||||||
|
@@ -156,21 +156,21 @@ mvn -Dsuites=org.apache.mxnet.NDArraySuite integration-test | |||||
``` | ||||||
|
||||||
If everything goes well, you will find jars for `assembly`, `core` and `example` modules. | ||||||
Also it produces the native library in `native/target`, which you can use to cooperate with the `core` module. | ||||||
Also it produces the native library in `native/target`, which you can use in conjunction with the `core` module. | ||||||
|
||||||
Deploy to repository | ||||||
-------------------- | ||||||
|
||||||
By default, `maven deploy` will deploy artifacts to local file system, you can file then in: ``scala-package/deploy/target/repo`` folder. | ||||||
By default, `maven deploy` will deploy artifacts to local file system, you can find them in the ``scala-package/deploy/target/repo`` folder. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
For nightly build in CI, a snapshot build will be uploaded to apache repository with follow command: | ||||||
For nightly builds (typically done by CI), a snapshot build will be uploaded to an apache snapshot repository with the following command: | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
```bash | ||||||
cd scala-package | ||||||
mvn deploy -Pnightly | ||||||
``` | ||||||
|
||||||
Use following command to deploy release build (push artifacts to apache staging repository): | ||||||
Use the following command when performing a release (pushes artifacts to an apache staging repository): | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Previous statement was good enough, I guess (in terms of comprehensibility)
Suggested change
|
||||||
|
||||||
```bash | ||||||
cd scala-package | ||||||
|
@@ -208,7 +208,7 @@ Caused by: java.lang.ClassNotFoundException: org.apache.mxnet.NDArray | |||||
at sun.misc.Launcher$AppClassLoader.loadClass(Launcher.java:331) | ||||||
at java.lang.ClassLoader.loadClass(ClassLoader.java:357) | ||||||
``` | ||||||
Please make sure your $CLASSPATH is able to find `mxnet-full_scala_version-INTERNAL.jar`. | ||||||
Please make sure your $CLASSPATH contains `mxnet-full_scala_version-INTERNAL.jar`. | ||||||
|
||||||
- To set up the Scala Project using IntelliJ IDE on macOS follow the instructions [here](https://mxnet.incubator.apache.org/tutorials/scala/mxnet_scala_on_intellij.html). | ||||||
- Several examples on using the Scala APIs are provided in the [Scala Examples Folder](https://github.com/apache/incubator-mxnet/tree/master/scala-package/examples/) | ||||||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.