https://github.com/sociomantic-tsunami/dmxnet

D bindings and wrapper library for the MXNet deep learning library
https://github.com/sociomantic-tsunami/dmxnet

Last synced: about 2 months ago
JSON representation

D bindings and wrapper library for the MXNet deep learning library

• Host: GitHub
• URL: https://github.com/sociomantic-tsunami/dmxnet
• Owner: sociomantic-tsunami
• License: bsl-1.0
• Created: 2017-08-01T15:27:55.000Z (about 7 years ago)
• Default Branch: v0.x.x
• Last Pushed: 2019-09-11T16:56:00.000Z (about 5 years ago)
• Last Synced: 2024-06-12T07:19:12.224Z (3 months ago)
• Language: D
• Size: 177 KB
• Stars: 13
• Watchers: 8
• Forks: 11
• Open Issues: 8
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE.txt

Awesome Lists containing this project

• Awesome-MXNet - dmxnet

README

        
Description

===========

``dmxnet`` provides D bindings for the `MXNet `_ deep learning

library, together with a friendly D2 wrapper library to allow more idiomatic use

within libraries and applications.

The currently implemented bindings and wrapper library cover only a small core

collection of the full MXNet functionality: we are not aiming for comprehensive

support for everything MXNet can do, only good support for the main essentials.

Further design constraints include:

* ``dmxnet`` is not cross-platform: we are only supporting Linux at present

* ``dmxnet`` is not written to support multithreading D code, although it

  should work with multithreaded MXNet engines

Build/Use

=========

Dependencies

------------

Packages

********

``libmxnet`` (``-lmxnet``) v1.0.0 or greater is required to build, and can be

installed from the package provided in our `deb repository

`_.

``zlib`` (``-lz``) is required in order to run integration tests, and can be

installed (on Debian/Ubuntu systems) via the ``zlib1g-dev`` package.

Submodules

**********

========== =======

Dependency Version

========== =======

ocean      v4.4.x

========== =======

If you plan to use the provided ``Makefile`` (e.g. to run integration tests),

you will also need to check out submodules with ``git submodule update --init``.

This will fetch source code for `Makd

`_ (used by the ``Makefile``)

into ``submodules/makd``.  It will also check out the source code for ``ocean``

and ``beaver``.  (The latter can be ignored as it is only used by the Travis CI

setup.)

Versioning

==========

``dmxnet`` follows the `Neptune

`_

semantic versioning scheme.  Note that while it is in early ``0.x`` development,

increases to the minor version number may include both new features and breaking

changes.  Patch releases are unlikely at this stage but should contain only

bugfixes.

Once a ``1.0.0`` version has been released, breaking changes will only be made

when increasing the major version number.

Support Guarantees

------------------

Given the early ``0.x`` state of development, only the latest minor release will

be supported.  This policy will be updated once a ``1.0.0`` release has been

made.

Releases

========

`Latest release notes

`_ | `All

releases `_

Releases are handled using GitHub releases.  The notes associated with a major

or minor github release are designed to help developers to migrate from one

version to another. The changes listed are the steps you need to take to move

from the previous version to the one listed.

The release notes are structured in 3 sections, a **Migration Instructions**,

which are the mandatory steps that users have to do to update to a new version,

**Deprecated** which contains deprecated functions that are recommended not to

use but will not break any old code, and the **New Features** which are optional

new features available in the new version that users might find interesting.

Using them is optional, but encouraged.

Contributing

============

See the guide for `contributing to Neptune-versioned libraries

`_.