2019-02-13 16:24:22 -08:00
<!--- Licensed to the Apache Software Foundation (ASF) under one -->
<!--- or more contributor license agreements. See the NOTICE file -->
<!--- distributed with this work for additional information -->
<!--- regarding copyright ownership. The ASF licenses this file -->
<!--- to you under the Apache License, Version 2.0 (the -->
<!--- "License"); you may not use this file except in compliance -->
<!--- with the License. You may obtain a copy of the License at -->
2019-02-13 10:12:12 -08:00
2019-02-13 16:24:22 -08:00
<!--- http://www.apache.org/licenses/LICENSE-2.0 -->
2019-02-13 10:12:12 -08:00
2019-02-13 16:24:22 -08:00
<!--- Unless required by applicable law or agreed to in writing, -->
<!--- software distributed under the License is distributed on an -->
<!--- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -->
<!--- KIND, either express or implied. See the License for the -->
<!--- specific language governing permissions and limitations -->
<!--- under the License. -->
2019-02-13 10:12:12 -08:00
2018-06-01 10:36:01 -07:00
<div align="center">
<a href="https://mxnet.incubator.apache.org/"><img src="https://raw.githubusercontent.com/dmlc/web-data/master/mxnet/image/mxnet_logo_2.png"></a><br>
</div>
2017-08-09 17:16:23 -07:00
Apache MXNet (incubating) for Deep Learning
2015-09-18 11:56:23 -07:00
=====
2018-06-01 10:36:01 -07:00
| Master | Docs | License |
| :-------------:|:-------------:|:--------:|
| [](http://jenkins.mxnet-ci.amazon-ml.com/job/incubator-mxnet/job/master/) | [](https://mxnet.incubator.apache.org/) | [](./LICENSE) |
2015-07-03 19:08:50 -06:00
2016-04-13 20:52:50 -07:00
2017-08-09 17:16:23 -07:00
Apache MXNet (incubating) is a deep learning framework designed for both * efficiency * and * flexibility * .
2017-10-13 09:48:02 -07:00
It allows you to * * *mix*** [symbolic and imperative programming ](https://mxnet.incubator.apache.org/architecture/index.html#deep-learning-system-design-concepts )
2017-03-07 09:20:28 -08:00
to * * *maximize*** efficiency and productivity.
At its core, MXNet contains a dynamic dependency scheduler that automatically parallelizes both symbolic and imperative operations on the fly.
2016-01-27 09:36:28 -07:00
A graph optimization layer on top of that makes symbolic execution fast and memory efficient.
2017-03-07 09:20:28 -08:00
MXNet is portable and lightweight, scaling effectively to multiple GPUs and multiple machines.
2015-11-15 11:11:21 -08:00
2019-03-28 19:27:34 -04:00
MXNet is more than a deep learning project. It is a collection of
2017-10-13 09:48:02 -07:00
[blue prints and guidelines ](https://mxnet.incubator.apache.org/architecture/index.html#deep-learning-system-design-concepts ) for building
2017-03-07 09:20:28 -08:00
deep learning systems, and interesting insights of DL systems for hackers.
2015-09-23 19:42:31 -04:00
2018-08-17 08:54:00 -07:00
Ask Questions
-------------
* Please use [discuss.mxnet.io ](https://discuss.mxnet.io/ ) for asking questions.
* Please use [mxnet/issues ](https://github.com/apache/incubator-mxnet/issues ) for reporting bugs.
* [Frequent Asked Questions ](https://mxnet.incubator.apache.org/faq/faq.html )
How to Contribute
-----------------
* [Contribute to MXNet ](https://mxnet.incubator.apache.org/community/contribute.html )
2015-09-28 16:42:35 -07:00
2015-09-26 22:42:20 -07:00
What's New
----------
2019-03-15 19:41:49 +08:00
* [Version 1.4.0 Release ](https://github.com/apache/incubator-mxnet/releases/tag/1.4.0 ) - MXNet 1.4.0 Release.
2018-11-27 23:34:51 +01:00
* [Version 1.3.1 Release ](https://github.com/apache/incubator-mxnet/releases/tag/1.3.1 ) - MXNet 1.3.1 Patch Release.
2018-09-17 11:14:11 -07:00
* [Version 1.3.0 Release ](https://github.com/apache/incubator-mxnet/releases/tag/1.3.0 ) - MXNet 1.3.0 Release.
2018-05-23 13:52:09 -07:00
* [Version 1.2.0 Release ](https://github.com/apache/incubator-mxnet/releases/tag/1.2.0 ) - MXNet 1.2.0 Release.
2018-03-08 15:44:29 -08:00
* [Version 1.1.0 Release ](https://github.com/apache/incubator-mxnet/releases/tag/1.1.0 ) - MXNet 1.1.0 Release.
2017-12-21 14:57:22 -08:00
* [Version 1.0.0 Release ](https://github.com/apache/incubator-mxnet/releases/tag/1.0.0 ) - MXNet 1.0.0 Release.
2017-12-05 10:55:33 -08:00
* [Version 0.12.1 Release ](https://github.com/apache/incubator-mxnet/releases/tag/0.12.1 ) - MXNet 0.12.1 Patch Release.
2017-10-31 10:35:28 -07:00
* [Version 0.12.0 Release ](https://github.com/apache/incubator-mxnet/releases/tag/0.12.0 ) - MXNet 0.12.0 Release.
2017-09-19 16:28:02 -07:00
* [Version 0.11.0 Release ](https://github.com/apache/incubator-mxnet/releases/tag/0.11.0 ) - MXNet 0.11.0 Release.
2017-07-28 12:33:41 -07:00
* [Apache Incubator ](http://incubator.apache.org/projects/mxnet.html ) - We are now an Apache Incubator project.
2017-05-26 17:25:08 -07:00
* [Version 0.10.0 Release ](https://github.com/dmlc/mxnet/releases/tag/v0.10.0 ) - MXNet 0.10.0 Release.
2017-01-22 11:07:09 -08:00
* [Version 0.9.3 Release ](./docs/architecture/release_note_0_9.md ) - First 0.9 official release.
2016-12-29 00:48:20 -08:00
* [Version 0.9.1 Release (NNVM refactor) ](./docs/architecture/release_note_0_9.md ) - NNVM branch is merged into master now. An official release will be made soon.
* [Version 0.8.0 Release ](https://github.com/dmlc/mxnet/releases/tag/v0.8.0 )
2016-12-04 17:43:36 -08:00
* [Updated Image Classification with new Pre-trained Models ](./example/image-classification )
2019-03-21 00:22:27 +00:00
* [Notebooks How to Use MXNet ](https://github.com/d2l-ai/d2l-en )
2019-03-19 13:36:06 +08:00
* [MKLDNN for Faster CPU Performance ](./docs/tutorials/mkldnn/MKLDNN_README.md )
2016-04-22 15:17:40 -07:00
* [MXNet Memory Monger, Training Deeper Nets with Sublinear Memory Cost ](https://github.com/dmlc/mxnet-memonger )
2016-04-07 22:15:21 -07:00
* [Tutorial for NVidia GTC 2016 ](https://github.com/dmlc/mxnet-gtc-tutorial )
2018-01-26 19:49:15 -08:00
* [Embedding Torch layers and functions in MXNet ](https://mxnet.incubator.apache.org/faq/torch.html )
2015-12-04 18:04:14 -07:00
* [MXNet.js: Javascript Package for Deep Learning in Browser (without server)
2015-12-04 18:05:03 -07:00
](https://github.com/dmlc/mxnet.js/)
2017-10-13 09:48:02 -07:00
* [Design Note: Design Efficient Deep Learning Data Loading Module ](https://mxnet.incubator.apache.org/architecture/note_data_loading.html )
2018-01-26 19:49:15 -08:00
* [MXNet on Mobile Device ](https://mxnet.incubator.apache.org/faq/smart_device.html )
* [Distributed Training ](https://mxnet.incubator.apache.org/faq/multi_devices.html )
* [Guide to Creating New Operators (Layers) ](https://mxnet.incubator.apache.org/faq/new_op.html )
2016-12-23 12:59:29 +08:00
* [Go binding for inference ](https://github.com/songtianyi/go-mxnet-predictor )
* [Amalgamation and Go Binding for Predictors ](https://github.com/jdeng/gomxnet/ ) - Outdated
2017-10-13 09:48:02 -07:00
* [Large Scale Image Classification ](https://github.com/apache/incubator-mxnet/tree/master/example/image-classification )
2015-04-30 10:06:16 -07:00
2015-09-18 11:56:23 -07:00
Contents
--------
2017-10-13 09:48:02 -07:00
* [Documentation ](https://mxnet.incubator.apache.org/ ) and [Tutorials ](https://mxnet.incubator.apache.org/tutorials/ )
* [Design Notes ](https://mxnet.incubator.apache.org/architecture/index.html )
2018-08-17 08:54:00 -07:00
* [Code Examples ](https://github.com/apache/incubator-mxnet/tree/master/example )
2018-01-26 19:49:15 -08:00
* [Installation ](https://mxnet.incubator.apache.org/install/index.html )
2018-08-17 08:54:00 -07:00
* [Pretrained Models ](http://mxnet.incubator.apache.org/api/python/gluon/model_zoo.html )
2015-09-18 11:56:23 -07:00
Features
--------
2016-01-27 09:36:28 -07:00
* Design notes providing useful insights that can re-used by other DL projects
* Flexible configuration for arbitrary computation graph
2017-03-07 09:20:28 -08:00
* Mix and match imperative and symbolic programming to maximize flexibility and efficiency
2016-01-27 09:36:28 -07:00
* Lightweight, memory efficient and portable to smart devices
* Scales up to multi GPUs and distributed setting with auto parallelism
2019-01-24 09:54:59 -08:00
* Support for Python, Scala, C++, Java, Clojure, R and Julia
2016-01-27 09:36:28 -07:00
* Cloud-friendly and directly compatible with S3, HDFS, and Azure
2015-09-18 11:56:23 -07:00
License
-------
2018-08-17 08:54:00 -07:00
Licensed under an [Apache-2.0 ](https://github.com/apache/incubator-mxnet/blob/master/LICENSE ) license.
2015-09-28 18:07:15 -07:00
2015-12-02 01:46:28 -05:00
Reference Paper
---------------
Tianqi Chen, Mu Li, Yutian Li, Min Lin, Naiyan Wang, Minjie Wang, Tianjun Xiao,
Bing Xu, Chiyuan Zhang, and Zheng Zhang.
2015-12-02 01:47:33 -05:00
[MXNet: A Flexible and Efficient Machine Learning Library for Heterogeneous Distributed Systems ](https://github.com/dmlc/web-data/raw/master/mxnet/paper/mxnet-learningsys.pdf ).
2015-12-04 11:20:25 -05:00
In Neural Information Processing Systems, Workshop on Machine Learning Systems, 2015
2015-12-02 01:46:28 -05:00
2015-09-28 18:07:15 -07:00
History
-------
2017-03-07 09:20:28 -08:00
MXNet emerged from a collaboration by the authors of [cxxnet ](https://github.com/dmlc/cxxnet ), [minerva ](https://github.com/dmlc/minerva ), and [purine2 ](https://github.com/purine/purine2 ). The project reflects what we have learned from the past projects. MXNet combines aspects of each of these projects to achieve flexibility, speed, and memory efficiency.
