Metadata-Version: 2.1
Name: cs272-project
Version: 0.2.0
Summary: NLP Final Project
Home-page: https://github.com/taoyilee/cs272_project
Author: Michael Tao-Yi Lee
Author-email: taoyil@uci.edu
License: MIT license
Keywords: cs272_project
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.5
Requires-Dist: Click (>=7.0)
Requires-Dist: torch (==1.4.0)
Requires-Dist: transformers (==2.4.1)
Requires-Dist: youtokentome (==1.0.6)
Requires-Dist: tqdm (==4.42.1)
Requires-Dist: configobj (==5.0.6)
Requires-Dist: tensorboard (==2.1.0)
Requires-Dist: google-cloud-bigquery (==1.24.0)
Requires-Dist: pandas (==1.0.1)

=============
CS272 Project
=============


.. image:: https://img.shields.io/pypi/v/cs272_project.svg
        :target: https://pypi.python.org/pypi/cs272_project

.. image:: https://img.shields.io/travis/taoyilee/cs272_project.svg
        :target: https://travis-ci.com/taoyilee/cs272_project

.. image:: https://readthedocs.org/projects/cs272-project/badge/?version=latest
        :target: https://cs272-project.readthedocs.io/en/latest/?badge=latest
        :alt: Documentation Status


.. image:: https://pyup.io/repos/github/taoyilee/cs272_project/shield.svg
     :target: https://pyup.io/repos/github/taoyilee/cs272_project/
     :alt: Updates



NLP Final Project


* Free software: MIT license
* Documentation: https://cs272-project.readthedocs.io.

Quick Start
-------------
Replication Only
======================
Following the steps below to setup training environment

.. code-block:: bash

    mkdir work_directory
    cd work_directory
    # create virtual environment under work_directory, naming it to "venv"
    python -m venv venv
    source venv/bin/activate
    # install the package
    pip install cs272-project
    # write configuration file to a working directory
    cs272_project_cli write-config --outfile /home/tylee/PycharmProjects/nlp_workspace

Development
======================
First of all, please fork the project if you are interested in extending its functionalities.
After that, you may clone the repository with:

.. code-block:: bash

    git clone git@github.com:<user_name>/nlp_project.git

Pull requests welcome!

Dependencies
======================
1. `PyTorch <https://pytorch.org/>`_ == 1.4.0
2. `YouTokenToMe <https://github.com/VKCOM/YouTokenToMe>`_ (yttm) == 1.0.6
3. `Huggingface Transformers <https://github.com/huggingface/transformers>`_ == 2.4.1
4. Click >= 0.7

Features
--------

* TODO

Credits
-------

This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage


=======
History
=======

0.1.0 (2020-02-15)
------------------

* First release on PyPI.

0.2.0 (2020-03-01)
-------------------------
* Change the fine tuning method to work with GPT2TANDAModel() which is a dual head model for AS2 and ODQA


