Skip to content

Latest commit

 

History

History
94 lines (72 loc) · 2.81 KB

README.md

File metadata and controls

94 lines (72 loc) · 2.81 KB

DJL - MXNet engine implementation

Overview

This module contains the MXNet implementation of the Deep Java Library (DJL) EngineProvider.

We don't recommend that developers use classes in this module directly. Use of these classes will couple your code with MXNet and make switching between frameworks difficult. Even so, developers are not restricted from using engine-specific features. For more information, see NDManager#invoke().

Documentation

The latest javadocs can be found on the djl.ai website.

You can also build the latest javadocs locally using the following command:

./gradlew javadoc

The javadocs output is built in the build/doc/javadoc folder.

Installation

You can pull the MXNet engine from the central Maven repository by including the following dependency:

<dependency>
    <groupId>ai.djl.mxnet</groupId>
    <artifactId>mxnet-engine</artifactId>
    <version>0.2.1</version>
    <scope>runtime</scope>
</dependency>

Besides the mxnet-engine library, you may also need to include the MXNet native library in your project. Choose a native library based on your platform and needs:

macOS

For macOS, you can choose between the following two libraries:

  • org.apache.mxnet:mxnet-native-mkl:1.6.0-b:osx-x86_64

    This package takes advantage of the Intel MKL library to boost performance.

    <dependency>
      <groupId>org.apache.mxnet</groupId>
      <artifactId>mxnet-native-mkl</artifactId>
      <classifier>osx-x86_64</classifier>
      <version>1.6.0-b</version>
      <scope>runtime</scope>
    </dependency>

Linux

For the Linux platform, you can choose between CPU, MKL, CUDA and CUDA+MKL combinations:

CUDA+MKL:

  • org.apache.mxnet:mxnet-native-cu101mkl:1.6.0-b:linux-x86_64
  • org.apache.mxnet:mxnet-native-cu92mkl:1.6.0-b:linux-x86_64
    <dependency>
      <groupId>org.apache.mxnet</groupId>
      <artifactId>mxnet-native-cu101mkl</artifactId>
      <classifier>linux-x86_64</classifier>
      <version>1.6.0-b</version>
      <scope>runtime</scope>
    </dependency>
    <dependency>
      <groupId>org.apache.mxnet</groupId>
      <artifactId>mxnet-native-cu92mkl</artifactId>
      <classifier>linux-x86_64</classifier>
      <version>1.6.0-b</version>
      <scope>runtime</scope>
    </dependency>

CPU and MKL

  • org.apache.mxnet:mxnet-native-mkl:1.6.0-b:linux-x86_64
    <dependency>
      <groupId>org.apache.mxnet</groupId>
      <artifactId>mxnet-native-mkl</artifactId>
      <classifier>linux-x86_64</classifier>
      <scope>runtime</scope>
      <version>1.6.0-b</version>
    </dependency>

Windows

Coming soon