Skip to content

The goal of this project is to conduct the analysis of the relationship between the protagonist/antagonist, the crime setting, and the details of the crime in the novels you analyzed for Project 1.

Notifications You must be signed in to change notification settings

NLPaladins/rinehartAnalysis_wordVectors

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Rinehart Analysis with Word Vectors

GitHub license

About

Project Board, Current Issues, Assignment

Rinehart Analysis using Word Vectors for NLP (ECE-617) Project 2.

Libraries Overview

All the libraries are located under <project root>/nlp_libs

Where to put the code

The code is reloaded automatically. Any class object needs to reinitialized though.

Table of Contents

Prerequisites

You need to have a machine with Python >= 3.9 and any Bash based shell (e.g. zsh) installed. Having installed conda is also recommended.

$ python3.9 -V
Python 3.9.7

$ echo $SHELL
/usr/bin/zsh

Bootstrap Project

All the installation steps are being handled by the Makefile.

If you want to use conda run:

$ make install

If you want to use venv run:

$ make install env=venv

Using Jupyter

Modifying the Configuration

You may need to configure the yml file. There is an already configured yml file under confs/proj_2.yml.

Local Jupyter

First, make sure you are in the correct virtual environment:

$ conda activate rinehartAnalysis_wordVectors

$ which python
/home/<your user>/anaconda3/envs/rinehartAnalysis_wordVectors/bin/python

To use jupyter, first run jupyter:

jupyter notebook

And open the main.ipynb.

Google Collab

Just Open this Google Collab Link.

Adding New Libraries

If you want to add a new library (e.g. a Class) in the project you need to follow these steps:

  1. Create a new folder under "<project root>/nlp_libs" with a name like my_lib
  2. Create a new python file inside it with a name like my_module.py
  3. Paste your code inside it
  4. Create a new file name init.py
  5. Paste the following code inside it:
     """<Library name> sub-package."""
     
     from .<Module name> import <Class Name>
     
     __email__ = "[email protected], kgeorgio.vols.utk.edu, [email protected]"
     __author__ = "jeanmerlet, drkostas, LaneMatthewJ"
     __version__ = "0.1.0"
  6. Open <project root>/nlp_libs/__init__.py
  7. Add the following line: from nlp_libs.<Module name> import <Class Name>
  8. (Optional) Rerun make install or python setup.py install

TODO

Read the TODO to see the current task list.

License

This project is licensed under the MIT License - see the LICENSE file for details.

About

The goal of this project is to conduct the analysis of the relationship between the protagonist/antagonist, the crime setting, and the details of the crime in the novels you analyzed for Project 1.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •