Skip to content
Browse files

add installation and quick start in

  • Loading branch information...
ljshou committed Apr 28, 2019
1 parent b68048f commit 0b3bc05af04cd8a62562b07002b386cf87145d81
Showing with 48 additions and 1 deletion.
  1. +48 −1
@@ -52,7 +52,54 @@ The advantages of leveraging NeuronBlocks for NLP neural network model training

# Get Started
Please refer to []( and [Code documentation](
## <span id="installation">Installation</span>

*Note: NeuronBlocks is based on Python 3.6*

1. Clone this project.
git clone

2. Install Python packages in requirements.txt by the following command.
pip install -r requirements.txt

3. Install PyTorch (*NeuronBlocks supports PyTorch version 0.4.1 currently*).

For **Linux**, run the following command:
pip install torch==0.4.1

For **Windows**, we suggest you to install PyTorch via *Conda* by following the instruction of [PyTorch](

## <span id="quick-start">Quick Start</span>

Get started by trying the given examples.

*Tips: in the following instruction, PROJECTROOT denotes the root directory of this project.*

# get GloVe pre-trained word vectors
cd PROJECT_ROOT/dataset
# train
python --conf_path=model_zoo/demo/conf.json
# test
python --conf_path=model_zoo/demo/conf.json
# predict
python --conf_path=model_zoo/demo/conf.json

For more details, please refer to []( and [Code documentation](

# Contribute

0 comments on commit 0b3bc05

Please sign in to comment.
You can’t perform that action at this time.