This project implements differentible stacks and queues in PyTorch. We also provide implementations of neural models utilizing these data structures and tasks that the models can be trained on. All this code is associated with the paper Context-Free Transductions with Neural Stacks, which appeared at the Analyzing and Interpreting Neural Networks for NLP workshop at EMNLP 2018. Refer to our paper for more theoretical background on differentiable data structures.
Check example.ipynb for the most up-to-date demo code.
There are several experiment configurations pre-defined in configs.py. To train a model on one of these configs, do:
python run.py CONFIG_NAME
For example, to train a model on the string reversal task:
python run.py final_reverse_config
In addition to the experiment configuration argument, run.py takes several flags:
--model
: Model type (BufferedModel
orVanillaModel
)--controller
: Controller type (LinearSimpleStructController
,LSTMSimpleStructController
, etc.)--struct
: Struct type (Stack
,NullStruct
, etc.)--savepath
: Path for saving a trained model--loadpath
: Path for loading a model
You can find auto-generated documentation here.
This project is managed by Computational Linguistics at Yale. We welcome contributions from outside in the form of pull requests. Please report any bugs in the GitHub issues tracker. If you are a Yale student interested in joining our lab, please contact Bob Frank.
If you use this codebase in your research, please cite the associated paper:
@article{hao2018context,
title={Context-Free Transductions with Neural Stacks},
author={Hao, Yiding and Merrill, William and Angluin, Dana and Frank, Robert and Amsel, Noah and Benz, Andrew and Mendelsohn, Simon},
journal={arXiv preprint arXiv:1809.02836},
year={2018}
}
Python 2.7 with PyTorch 0.4.1 is supported. A possibly incomplete list of dependencies is:
pytorch
numpy
scipy
(for data processing)matplotlib
(for visualization)enum
(for backward compatibility)
Using pip or conda should suffice for installing most of these dependencies. To get the right command for installing PyTorch, refer to the installation widget on the PyTorch website.
Models implement the high-level controllers that use a stack for recurrent memory. You can think of these networks as LSTMs with a more sophisticated storage mechanism to pass data between time steps.
models.VanillaModel
is a simple controller-data structure network.models.BufferedModel
adds input and output buffers to the vanilla model.
To use a model, call model.forward()
on every input and model.init_controller()
whenever you want to reset the stack between inputs. You can find example training logic in the tasks
package.
structs.Stack
implements the differentiable stack data structure.structs.Queue
implements the differentiable queue data structure.
The buffered models use read-only and write-only versions of the differentiable queue for their input and output buffers.
Below are some formal language tasks that we have explored using stack models.
The ReverseTask
trains a feed-forward controller network to do string reversal. The code generates 800 random binary strings which the network must reverse in a sequence-to-sequence fashion:
Input: 1 1 0 1 # # # #
Label: # # # # 1 0 1 1
By 10 epochs, the model tends to achieve 100% accuracy. The config for this task is called final_reverse_config
.
CFGTask
can be used to train a context-free language model. Many interesting questions probing linguistic structure can be reduced to special cases of this general task. For example, the task can be used to model a language of balanced parentheses. The configuration for the parentheses task is final_dyck_config
.
We also have a class for evaluation tasks. These are tasks where output i can be succintly expressed as some function of inputs 0, .., i. Some applications of this are evaluation of parity and reverse polish boolean formulae.
The data folder contains several real datasets that the stack can be trained on. We should implement a task for reading in these datasets.