Skip to content
Amazon Deep Learning's Keras with Apache MXNet support
Branch: master
Clone or download
Pull request Compare This branch is 65 commits ahead, 246 commits behind keras-team:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
benchmark Update units for inference benchmark to be samples/sec (#206) Oct 30, 2018
docker Update Dockerfile to fix error introduced by keras-team#11011 (keras-… Sep 4, 2018
docs update rnn doc title (#205) Oct 30, 2018
examples merge keras-mxnet with keras 2.2.4 Oct 8, 2018
keras fix nightly on sgd (#225) Feb 22, 2019
keras_mxnet_ci update build spec Oct 9, 2018
tests
.coveragerc Moved the preprocessing tests into the integration directory. (keras-… Aug 25, 2018
.gitignore
.travis.yml
CONTRIBUTING.md Update strings from Python 3.5 to 3.6 (keras-team#9062) Jan 12, 2018
ISSUE_TEMPLATE.md
LICENSE
MANIFEST.in
PULL_REQUEST_TEMPLATE.md Update the PR template. Ready for keras-mxnet v2.2.2 release Aug 15, 2018
README.md
pytest.ini increase timeout limit (#201) Oct 16, 2018
setup.cfg
setup.py Prepare Keras-MXNet 2.2.4.1 release (#199) Oct 15, 2018

README.md

Keras: Deep Learning for humans

Keras logo

ubuntu/python-2.7 ubuntu/python-3.5
Python3 Build Status Python2 Build Status

license

You have just found Keras-MXNet

Keras is a high-level neural networks API, written in Python and capable of running on top of Apache MXNet (incubating), TensorFlow, CNTK, or Theano. It was developed with a focus on enabling fast experimentation. Being able to go from idea to result with the least possible delay is key to doing good research.

Keras-MXNet is the fork of Keras project and adds support for the high-performance, scalable deep learning library MXNet as a backend.

Detailed documentation for the MXNet backend are provided in the docs/mxnet_backend folder.

Use Keras if you need a deep learning library that:

  • Allows for easy and fast prototyping (through user friendliness, modularity, and extensibility).
  • Supports both convolutional networks and recurrent networks, as well as combinations of the two.
  • Runs seamlessly on CPU and GPU.

Read the documentation at Keras.io.

Keras is compatible with: Python 2.7-3.6.


Guiding principles

  • User friendliness. Keras is an API designed for human beings, not machines. It puts user experience front and center. Keras follows best practices for reducing cognitive load: it offers consistent & simple APIs, it minimizes the number of user actions required for common use cases, and it provides clear and actionable feedback upon user error.

  • Modularity. A model is understood as a sequence or a graph of standalone, fully-configurable modules that can be plugged together with as few restrictions as possible. In particular, neural layers, cost functions, optimizers, initialization schemes, activation functions, regularization schemes are all standalone modules that you can combine to create new models.

  • Easy extensibility. New modules are simple to add (as new classes and functions), and existing modules provide ample examples. To be able to easily create new modules allows for total expressiveness, making Keras suitable for advanced research.

  • Work with Python. No separate models configuration files in a declarative format. Models are described in Python code, which is compact, easier to debug, and allows for ease of extensibility.


Getting started: 30 seconds to Keras

The core data structure of Keras is a model, a way to organize layers. The simplest type of model is the Sequential model, a linear stack of layers. For more complex architectures, you should use the Keras functional API, which allows to build arbitrary graphs of layers.

Here is the Sequential model:

from keras.models import Sequential

model = Sequential()

Stacking layers is as easy as .add():

from keras.layers import Dense

model.add(Dense(units=64, activation='relu', input_dim=100))
model.add(Dense(units=10, activation='softmax'))

Once your model looks good, configure its learning process with .compile():

model.compile(loss='categorical_crossentropy',
              optimizer='sgd',
              metrics=['accuracy'])

If you need to, you can further configure your optimizer. A core principle of Keras is to make things reasonably simple, while allowing the user to be fully in control when they need to (the ultimate control being the easy extensibility of the source code).

model.compile(loss=keras.losses.categorical_crossentropy,
              optimizer=keras.optimizers.SGD(lr=0.01, momentum=0.9, nesterov=True))

You can now iterate on your training data in batches:

# x_train and y_train are Numpy arrays --just like in the Scikit-Learn API.
model.fit(x_train, y_train, epochs=5, batch_size=32)

Alternatively, you can feed batches to your model manually:

model.train_on_batch(x_batch, y_batch)

Evaluate your performance in one line:

loss_and_metrics = model.evaluate(x_test, y_test, batch_size=128)

Or generate predictions on new data:

classes = model.predict(x_test, batch_size=128)

Building a question answering system, an image classification model, a Neural Turing Machine, or any other model is just as fast. The ideas behind deep learning are simple, so why should their implementation be painful?

For a more in-depth tutorial about Keras, you can check out:

In the examples folder of the repository, you will find more advanced models: question-answering with memory networks, text generation with stacked LSTMs, etc.


Installation

Before installing Keras, please install one of its backend engines: MXNet, TensorFlow, Theano, or CNTK. We recommend the MXNet backend.

You may also consider installing the following optional dependencies:

Then, you can install Keras itself. There are two ways to install Keras:

  • Install Keras from PyPI (recommended):
sudo pip install keras-mxnet

If you are using a virtualenv, you may want to avoid using sudo:

pip install keras-mxnet
  • Alternatively: install Keras from the GitHub source:

First, clone Keras using git:

git clone https://github.com/awslabs/keras-apache-mxnet.git

Then, cd to the keras-apache-mxnet folder and run the install command:

cd keras
sudo python setup.py install

Configuring your Keras backend

By default, Keras-MXNet will use MXNet as its tensor manipulation library. Follow these instructions to configure the Keras backend.


Support

You can ask Keras-MXNet specific questions or post bug reports and feature requests in GitHub issues.

You can ask Keras questions and join the development discussion:

You can also post bug reports and feature requests (only) in GitHub issues. Make sure to read our guidelines first.


Why this name, Keras?

Keras (κέρας) means horn in Greek. It is a reference to a literary image from ancient Greek and Latin literature, first found in the Odyssey, where dream spirits (Oneiroi, singular Oneiros) are divided between those who deceive men with false visions, who arrive to Earth through a gate of ivory, and those who announce a future that will come to pass, who arrive through a gate of horn. It's a play on the words κέρας (horn) / κραίνω (fulfill), and ἐλέφας (ivory) / ἐλεφαίρομαι (deceive).

Keras was initially developed as part of the research effort of project ONEIROS (Open-ended Neuro-Electronic Intelligent Robot Operating System).

"Oneiroi are beyond our unravelling --who can be sure what tale they tell? Not all that men look for comes to pass. Two gates there are that give passage to fleeting Oneiroi; one is made of horn, one of ivory. The Oneiroi that pass through sawn ivory are deceitful, bearing a message that will not be fulfilled; those that come out through polished horn have truth behind them, to be accomplished for men who see them." Homer, Odyssey 19. 562 ff (Shewring translation).


You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.