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

Commit 91392c4

Browse files
committed
Added section on Scala training APIs
1 parent f0510a9 commit 91392c4

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

scala-package/README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,6 +144,23 @@ Examples & Usage
144144
- 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).
145145
- 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/)
146146

147+
Scala Training APIs
148+
-------
149+
- Module API :
150+
[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.
151+
152+
- Model API :
153+
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.
154+
155+
- KVStore API :
156+
To run training over multiple GPUs and multiple hosts, one can use the [KVStore API](https://mxnet.incubator.apache.org/api/scala/kvstore.html).
157+
158+
- IO/Data Loading :
159+
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.
160+
161+
Other available Scala APIs for training can be found [here](https://mxnet.incubator.apache.org/api/scala/index.html).
162+
163+
147164
Scala Inference APIs
148165
-------
149166
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).

0 commit comments

Comments
 (0)