Tree-Structured Long Short-Term Memory Networks
This is a PyTorch implementation of Tree-LSTM as described in the paper Improved Semantic Representations From Tree-Structured Long Short-Term Memory Networks by Kai Sheng Tai, Richard Socher, and Christopher Manning. On the semantic similarity task using the SICK dataset, this implementation reaches:
- Pearson's coefficient:
0.8492and MSE:0.2842using hyperparameters--lr 0.010 --wd 0.0001 --optim adagrad --batchsize 25 - Pearson's coefficient:
0.8674and MSE:0.2536using hyperparameters--lr 0.025 --wd 0.0001 --optim adagrad --batchsize 25 --freeze_embed - Pearson's coefficient:
0.8676and MSE:0.2532are the numbers reported in the original paper. - Known differences include the way the gradients are accumulated (normalized by batchsize or not).
Requirements
- Python (tested on 3.6.5, should work on >=2.7)
- Java >= 8 (for Stanford CoreNLP utilities)
- Other dependencies are in
requirements.txtNote: Currently works with PyTorch 0.4.0. Switch to thepytorch-v0.3.1branch if you want to use PyTorch 0.3.1.
Usage
Before delving into how to run the code, here is a quick overview of the contents:
- Use the script
fetch_and_preprocess.shto download the SICK dataset, Stanford Parser and Stanford POS Tagger, and Glove word vectors (Common Crawl 840) -- Warning: this is a 2GB download!), and additionally preprocees the data, i.e. generate dependency parses using Stanford Neural Network Dependency Parser. main.pydoes the actual heavy lifting of training the model and testing it on the SICK dataset. For a list of all command-line arguments, have a look atconfig.py.- The first run caches GLOVE embeddings for words in the SICK vocabulary. In later runs, only the cache is read in during later runs.
- Logs and model checkpoints are saved to the
checkpoints/directory with the name specified by the command line argument--expname.
Next, these are the different ways to run the code here to train a TreeLSTM model.
Local Python Environment
If you have a working Python3 environment, simply run the following sequence of steps:
- bash fetch_and_preprocess.sh
- pip install -r requirements.txt
- python main.py
Pure Docker Environment
If you want to use a Docker container, simply follow these steps:
- docker build -t treelstm .
- docker run -it treelstm bash
- bash fetch_and_preprocess.sh
- python main.py
Local Filesystem + Docker Environment
If you want to use a Docker container, but want to persist data and checkpoints in your local filesystem, simply follow these steps:
- bash fetch_and_preprocess.sh
- docker build -t treelstm .
- docker run -it --mount type=bind,source="$(pwd)",target="/root/treelstm.pytorch" treelstm bash
- python main.py
NOTE: Setting the environment variable OMP_NUM_THREADS=1 usually gives a speedup on the CPU. Use it like OMP_NUM_THREADS=1 python main.py. To run on a GPU, set the CUDA_VISIBLE_DEVICES instead. Usually, CUDA does not give much speedup here, since we are operating at a batchsize of 1.
Notes
- (Apr 02, 2018) Added Dockerfile
- (Apr 02, 2018) Now works on PyTorch 0.3.1 and Python 3.6, removed dependency on Python 2.7
- (Nov 28, 2017) Added frozen embeddings, closed gap to paper.
- (Nov 08, 2017) Refactored model to get 1.5x - 2x speedup.
- (Oct 23, 2017) Now works with PyTorch 0.2.0.
- (May 04, 2017) Added support for sparse tensors. Using the
--sparseargument will enable sparse gradient updates fornn.Embedding, potentially reducing memory usage.- There are a couple of caveats, however, viz. weight decay will not work in conjunction with sparsity, and results from the original paper might not be reproduced using sparse embeddings.
Acknowledgements
Shout-out to Kai Sheng Tai for the original LuaTorch implementation, and to the Pytorch team for the fun library.
Contact
This is my first PyTorch based implementation, and might contain bugs. Please let me know if you find any!
License
MIT
9 Jun 6, 2022
734 Jan 3, 2023
532 Jan 2, 2023
1.9k Jan 8, 2023
1 Dec 20, 2021
11 Oct 14, 2022
56 Dec 15, 2022
410 Jan 5, 2023
195 Dec 7, 2022
318 Dec 14, 2022
57 Dec 27, 2022
270 Dec 24, 2022
24 Nov 11, 2022
15 Aug 20, 2022
1 Oct 29, 2021
7 Oct 11, 2022
1 Jun 13, 2022
1 Nov 20, 2021