[GitHub] eric-haibin-lin closed pull request #9108: update README.md with details on typical usage of the scripts

[GitBox <gi...@apache.org>]

eric-haibin-lin closed pull request #9108: update README.md with details on typical usage of the scripts
URL: https://github.com/apache/incubator-mxnet/pull/9108
 
 
   

This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:

As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):

diff --git a/example/rnn/bucketing/README.md b/example/rnn/bucketing/README.md
index 6baf1ecae9..0481609c23 100644
--- a/example/rnn/bucketing/README.md
+++ b/example/rnn/bucketing/README.md
@@ -3,11 +3,34 @@ RNN Example
 This folder contains RNN examples using high level mxnet.rnn interface.
 
 ## Data
-Run `get_ptb_data.sh` to download PenTreeBank data.
+1) Review the license for the PenTreeBank dataset and ensure that you agree to it. Then uncomment the lines in the 'get_ptb_data.sh' script that download the dataset.
+
+2) Run `get_ptb_data.sh` to download PenTreeBank data.
 
 ## Python
 
-- [lstm_bucketing.py](lstm_bucketing.py) PennTreeBank language model by using LSTM
+- Generate the PennTreeBank language model by using LSTM:
+
+  For Python2 (CPU support): can take 2+ hours on AWS-EC2-p2.16xlarge
+
+      $ python  [lstm_bucketing.py](lstm_bucketing.py) 
+
+  For Python3 (CPU support): can take 2+ hours on AWS-EC2-p2.16xlarge
+
+      $ python3 [lstm_bucketing.py](lstm_bucketing.py) 
+
+  Assuming your machine has 4 GPUs and you want to use all the 4 GPUs:
+
+  For Python2 (GPU support only): can take 50+ minutes on AWS-EC2-p2.16xlarge
+
+      $ python  --gpus 0,1,2,3 [cudnn_lstm_bucketing.py](cudnn_lstm_bucketing.py) 
+
+  For Python3 (GPU support only): can take 50+ minutes on AWS-EC2-p2.16xlarge
+
+      $ python3 --gpus 0,1,2,3 [cudnn_lstm_bucketing.py](cudnn_lstm_bucketing.py) 
+
+
+### Performance Note:
+
+More ```MXNET_GPU_WORKER_NTHREADS``` may lead to better performance. For setting ```MXNET_GPU_WORKER_NTHREADS```, please refer to [Environment Variables](http://mxnet.incubator.apache.org/how_to/env_var.html).
 
-Performance Note:
-More ```MXNET_GPU_WORKER_NTHREADS``` may lead to better performance. For setting ```MXNET_GPU_WORKER_NTHREADS```, please refer to [Environment Variables](https://mxnet.readthedocs.org/en/latest/how_to/env_var.html).


 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services