fairseq-doc 1.2
Young's Sequence-Sequence Research Toolkit Extended on FAIRSeq
License: BSD License

For fairseq software

Copyright (c) 2017-present, Facebook, Inc. All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

 * Redistributions of source code must retain the above copyright notice, this
    list of conditions and the following disclaimer.

 * Redistributions in binary form must reproduce the above copyright notice,
    this list of conditions and the following disclaimer in the documentation
       and/or other materials provided with the distribution.

 * Neither the name Facebook nor the names of its contributors may be used to
    endorse or promote products derived from this software without specific
       prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Description: 
        # YoungSeq
        Young's Sequence-Sequence Research Toolkit Extended on FAIRSeq
        
        ### Preparation
        #### Requirements:
        * A [PyTorch installation](http://pytorch.org/)
        * For training new models, you'll also need an NVIDIA GPU and [NCCL](https://github.com/NVIDIA/nccl)
        * Python version 3.6
        
        Currently YoungSeq and FAIRSeq requires PyTorch version >= 1.0.0.
        Please follow the instructions here: https://github.com/pytorch/pytorch#installation.
        
        If you use Docker make sure to increase the shared memory size either with
        `--ipc=host` or `--shm-size` as command line options to `nvidia-docker run`.
        
        #### Install FAIRSeq:
        ```
        pip install fairseq
        ```
        
        #### Install YoungSeq:
        1. Install from PyPi
        ```
        pip install youngseq
        ```
        2. Install from source
        ```
        https://github.com/Jason-Young-NLP/YoungSeq.git
        cd youngseq
        pip install --editable .
        ```
        
        ### Experiments
        ```
        1. youngseq-document-preprocess
        2. youngseq-document-train
        3. youngseq-document-generate
        ```
        
Platform: UNKNOWN
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Description-Content-Type: text/markdown