CS272 Project¶
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
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:
git clone git@github.com:<user_name>/nlp_project.git
Pull requests welcome!
Dependencies¶
- PyTorch == 1.4.0
- YouTokenToMe (yttm) == 1.0.6
- Huggingface Transformers == 2.4.1
- Click >= 0.7
Features¶
- TODO
Credits¶
This package was created with Cookiecutter and the audreyr/cookiecutter-pypackage project template.