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

Commit

Permalink
Added section on Scala training APIs
Browse files Browse the repository at this point in the history
  • Loading branch information
piyushghai committed Dec 12, 2018
1 parent f0510a9 commit 91392c4
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions scala-package/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,23 @@ Examples & Usage
- 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/)

Scala Training APIs
-------
- Module API :
[The Module API](https://mxnet.incubator.apache.org/api/scala/module.html) provides an intermediate and high-level interface for performing computation with neural networks in MXNet. Modules provide high-level APIs for training, predicting, and evaluating.

- Model API :
The Model API can be used to train models for deep learning. You can refer to [Model API](https://mxnet.incubator.apache.org/api/scala/model.html) for example usage to train a model.

This comment has been minimized.

Copy link
@nswamy

nswamy Dec 12, 2018

Member

Model API is deprecated

This comment has been minimized.

Copy link
@piyushghai

piyushghai Dec 12, 2018

Author Contributor

Oh. Wasn't aware of that. Will remove it from here :)

This comment has been minimized.

Copy link
@piyushghai

piyushghai Dec 12, 2018

Author Contributor

Done. Removed in : 2cdca99


- KVStore API :
To run training over multiple GPUs and multiple hosts, one can use the [KVStore API](https://mxnet.incubator.apache.org/api/scala/kvstore.html).

- IO/Data Loading :
MXNet Scala provides APIs for preparing data to feed as an input to models. Check out [Data Loading API](https://mxnet.incubator.apache.org/api/scala/io.html) for more info.

Other available Scala APIs for training can be found [here](https://mxnet.incubator.apache.org/api/scala/index.html).


Scala Inference APIs
-------
The [Scala Inference APIs](https://mxnet.incubator.apache.org/api/scala/infer.html) provide an easy, out of the box solution to load a pre-trained MXNet model and run inference on it. The Inference APIs are present in the [Infer Package](https://github.com/apache/incubator-mxnet/tree/master/scala-package/infer) under the MXNet Scala Package repository, while the documentation for the Infer API is available [here](https://mxnet.incubator.apache.org/api/scala/docs/index.html#org.apache.mxnet.infer.package).
Expand Down

0 comments on commit 91392c4

Please sign in to comment.