README.md
1<!--- Licensed to the Apache Software Foundation (ASF) under one -->
2<!--- or more contributor license agreements. See the NOTICE file -->
3<!--- distributed with this work for additional information -->
4<!--- regarding copyright ownership. The ASF licenses this file -->
5<!--- to you under the Apache License, Version 2.0 (the -->
6<!--- "License"); you may not use this file except in compliance -->
7<!--- with the License. You may obtain a copy of the License at -->
8
9<!--- http://www.apache.org/licenses/LICENSE-2.0 -->
10
11<!--- Unless required by applicable law or agreed to in writing, -->
12<!--- software distributed under the License is distributed on an -->
13<!--- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -->
14<!--- KIND, either express or implied. See the License for the -->
15<!--- specific language governing permissions and limitations -->
16<!--- under the License. -->
17
18RNN Example
19===========
20This folder contains RNN examples using low level symbol interface.
21
22## Data
23Run `get_sherlockholmes_data.sh` to download Sherlock Holmes data.
24
25## Python
26
27- [lstm.py](lstm.py) Functions for building a LSTM Network
28- [gru.py](gru.py) Functions for building a GRU Network
29- [lstm_bucketing.py](lstm_bucketing.py) Sherlock Holmes language model by using LSTM
30- [gru_bucketing.py](gru_bucketing.py) Sherlock Holmes language model by using GRU
31- [char-rnn.ipynb](char-rnn.ipynb) Notebook to demo how to train a character LSTM by using ```lstm.py```
32
33
34Performance Note:
35More ```MXNET_GPU_WORKER_NTHREADS``` may lead to better performance. For setting ```MXNET_GPU_WORKER_NTHREADS```, please refer to [Environment Variables](https://mxnet.apache.org/api/faq/env_var).
36