Metadata-Version: 2.1
Name: sru
Version: 3.0.0.dev0
Summary: Simple Recurrent Units for Highly Parallelizable Recurrence
Home-page: https://github.com/taolei87/sru
Author: Tao Lei, Yu Zhang, Sida I. Wang, Hui Dai and Yoav Artzi
Author-email: tao@asapp.com
License: MIT
Description: 
        ## About
        
        **SRU** is a recurrent unit that can run over 10 times faster than cuDNN LSTM, without loss of accuracy tested on many tasks. 
        <p align="center">
        <img width=620 src="https://raw.githubusercontent.com/taolei87/sru/master/imgs/speed.png"><br>
        <i>Average processing time of LSTM, conv2d and SRU, tested on GTX 1070</i><br>
        </p>
        For example, the figure above presents the processing time of a single mini-batch of 32 samples. SRU achieves 10 to 16 times speed-up compared to LSTM, and operates as fast as (or faster than) word-level convolution using conv2d.
        
        The [paper](https://arxiv.org/abs/1709.02755) has multiple versions, please check the latest one.
        
        #### Reference:
        Simple Recurrent Units for Highly Parallelizable Recurrence
        ```
        @inproceedings{lei2018sru,
          title={Simple Recurrent Units for Highly Parallelizable Recurrence},
          author={Tao Lei and Yu Zhang and Sida I. Wang and Hui Dai and Yoav Artzi},
          booktitle={Empirical Methods in Natural Language Processing (EMNLP)},
          year={2018}
        }
        ```
        <br>
        
        ## Requirements
         - [PyTorch](http://pytorch.org/) >=1.3.1 recommended, [pytorch installation details](docs/pytorch_installation.md)
         - [ninja](https://ninja-build.org/)
        
        Install requirements via `pip install -r requirements.txt`.
        
        <br>
        
        ## Installation
        
        #### From source:
        SRU can be installed as a regular package via `python setup.py install` or `pip install .`.
        
        #### From PyPi:
        `pip install sru`
        
        
        #### Directly use the source without installation:
        Make sure this repo and CUDA library can be found by the system, e.g. 
        ```
        export PYTHONPATH=path_to_repo/sru
        export LD_LIBRARY_PATH=/usr/local/cuda/lib64
        ```
        
        <br>
        
        ## Examples
        The usage of SRU is similar to `nn.LSTM`. SRU likely requires more stacking layers than LSTM. We recommend starting by 2 layers and use more if necessary (see our report for more experimental details).
        ```python
        import torch
        from sru import SRU, SRUCell
        
        # input has length 20, batch size 32 and dimension 128
        x = torch.FloatTensor(20, 32, 128).cuda()
        
        input_size, hidden_size = 128, 128
        
        rnn = SRU(input_size, hidden_size,
            num_layers = 2,          # number of stacking RNN layers
            dropout = 0.0,           # dropout applied between RNN layers
            bidirectional = False,   # bidirectional RNN
            layer_norm = False,      # apply layer normalization on the output of each layer
            highway_bias = 0,        # initial bias of highway gate (<= 0)
            rescale = True,          # whether to use scaling correction
        )
        rnn.cuda()
        
        output_states, c_states = rnn(x)      # forward pass
        
        # output_states is (length, batch size, number of directions * hidden size)
        # c_states is (layers, batch size, number of directions * hidden size)
        
        ```
          
        <br>
        
        ## Contributing
        Please read and follow the [guidelines](CONTRIBUTING.md).
        
        
        ### Other Implementations
        
        [@musyoku](https://github.com/musyoku) had a very nice [SRU implementaion](https://github.com/musyoku/chainer-sru) in chainer.
        
        [@adrianbg](https://github.com/adrianbg) implemented the first [CPU version](https://github.com/taolei87/sru/pull/42).
        
        <br>
        
          
        
Keywords: deep learning rnn lstm cudnn sru fast pytorch torch
Platform: UNKNOWN
Description-Content-Type: text/markdown
