README.md

582

CSC 582 Natural Language Processing

Documentation

Getting Started

1. Install Poetry

Works with macOS, Linux, Windows.

2. Setup virtual environment

poetry install

This will create a virtual environment with the required:

• Python 3.6.8
• all the [packages] listed in the pyproject.toml, which is standardized.

3. Open virtual environment

poetry shell

4. Verify your python version

$ poetry env info

Virtualenv
Python:         3.6.8
Implementation: CPython
Path:           /path/to/.../.../pypoetry/virtualenvs/582-Edwit1zX-py3.6
Valid:          True

System
Platform: darwin (example on macOS)
OS:       posix  (example on macOS)
Python:   /Library/Frameworks/Python.framework/Versions/3.6  (example on macOS)

5. Download NLP stuff

$ python -m spacy download en_core_web_sm
$ python -m spacy download en_core_web_lg

Module Examples

from labs.lab1 import producer
producer("good movie overview")
>>>
{
    "title": "A Good Movie Title",
    "director": "Good Director",
    "cast": ["Good Actress", "Good Actor"],
}
producer("bad movie overview")
>>>
{
    "title": "A Bad Movie Title",
    "director": "Bad Director",
    "cast": ["Bad Actress", "Bad Actor"],
}

Command-Line Usage

Lab1

$ python main.py lab1 inputs/in1.txt
$ python robotproducer.py inputs/in1.txt

How it works

Assumptions

• ...
• ...

Pipeline

1. ...
2. ...
3. ...

TODO

• ...
• ...

More Details

... ...

Resources

• foobar
• foobar