CS 5293 Spring 21

Logo

This is the web page for Text Analytics at the University of Oklahoma.

View the Project on GitHub oudalab/cs5293sp22

CS 5293, Spring 2022 Project 1

The Redactor

Introduction

Whenever sensitive information is shared with the public, the data must go through a redaction process. That is, all sensitive names, places, and other sensitive information must be hidden. Documents such as police reports, court transcripts, and hospital records all contain sensitive information. Redacting this information is often expensive and time consuming.

Task Overview

In this project, you will use your knowledge of Python and Text Analytics to design a system that accepts plain text documents then detect and redact “sensitive” items. Below is an example execution of the program. If your program cannot be run using this command you may lose points.

pipenv run python redactor.py --input '*.txt' \
                    --names --dates --phones --genders --address\
                    --concept 'kids' \
                    --output 'files/' \
                    --stats stderr

Running the program with this command line argument should read all files given by the glob — in this case all the files ending in .txt in the current folder. All these files will be redacted by the program. The program will look to redact all names and dates, and phone numbers. Notice the flag --concept, this flag asks the system to redact all portions of text that have anything to do with a particular concept. In this case, all sentences that contain information about kids should be redacted. It is up *you* to determine what represents a concept.

Each redacted file should be transformed into new files of the same name with the .redacted extension, and written to the folder described by --output flag. The final parameter, --stats, describes the file or location to write the statistics of the redacted files. Below we discuss each of the parameters in additional detail.

Parameters

–input

This parameter takes a glob that represents the files that can be accepted. More than one input flag may be used to specify groups of files. If a file cannot be read or redacted an appropriate error message should be displayed to the user.

–output

This flag should specify a directory to store all the redacted files. The redacted files, regardless of their input type should be written to text files. Each file should have the same name as the original file with the extension .redacted appended to the file name.

Redaction flags

The redaction flags list the entity types that should be extracted from all the input documents. The list of flags you are required to implements are:

You are free to add you own! --names corresponds to any type of name, it is up to you to define this. --genders should be any term that reveals the gender of an entity (e.g. him, her, father, mother, and many others). --dates correspond to any written dates (4/9/2023, April 9th, 22/2/22, etc.) --phones describes any phone number in its various forms. --address corresponds to any physical (postal) address (not e-mail address). In your README discussion file clearly give the parameters you apply to each of the flags. The redacted characters in the document should be replaced with a character of your choice. Some popular characters include the Unicode full block character █ (U+2588). You may choose to redact both words and the whitespaces between phrases. If you believe that one should also redact whitespaces between words (e.g. in a first and last name) please discuss why in your README.md.

–concept

This flag, which can be repeated one or more times, takes one word or phrase that represents a concept. A concept is either an idea or theme. Any section of the input files that refer to this concept should be redacted. For example, if the given concept word is prison, a sentence (or paragraph) either containing the word or similar concepts, such as jail or incarcerated, that whole sentence should be redacted. In your README file, make your definition of a concept clear. Also, clearly state how you create the context of a concept and justify your method. Be creative!! Use the tools you’ve learned along the way!

An example of creating an argument parser to handle a repeated argument.

parser.add_argument('--concept', action='append', help='<Required> Set flag', required=True)

To call a flag repeatedly via command line using argparse:

--concept prison --concept kids

—stats

Stats take either the name of a file or special files (stderr, stdout), and writes a summary of the redaction process.**You need to support all three of the cases.** Some statistics to include are the types and counts of redacted terms and the statistics of each redacted file. Be sure to describe the format of your outfile to in your README file. Stats should help you while developing your code. Stats may also include the begining and end index of each redacted item. It is up to you to design your stats output.

Dataset

For example documents we are asking you to use the Enron Email Dataset. The dataset contains 1.7 Gb (compressed) and 500,000 email messages. Scour the dataset for example text files that you can redact. The full data set is too large for your GitHub repository. You can use a portion of the data set that you find useful. Use the following command in your /tmp directory.

wget https://www.cs.cmu.edu/~enron/enron_mail_20150507.tar.gz
tar xvzf enron_mail_20150507.tar.gz

You can then use ls, or a hand tool called ranger to examine all of the files.

Submission

README.md

The README file name should be uppercase with an .md extension. You should write your name in it, an example of how to run it, and a list of any web or external resources that you used for help. The README file should also contain a list of any bugs or assumptions made while writing the program. Note that you should not be copying code from any website not provided by the instructor. You should include directions on how to install and use the code. You should describe any known bugs and cite any sources or people you used for help. Be sure to include any assumptions you make for your solution.

COLLABORATORS file

This file should contain a comma-separated list describing who you worked with and a small text description describing the nature of the collaboration. This information should be listed in three fields as in the example is below:

Katherine Johnson, kj@nasa.gov, Helped me understand calculations
Dorothy Vaughan, doro@dod.gov, Helped me with multiplexed time management

Project Descriptions

Your code structure should be in a directory with something similar to the following format:

cs5293sp22-project1/
├── COLLABORATORS
├── LICENSE
├── README
├── Pipfile
├── project1
│   └── main.py
│   └── ... 
├── docs/
├── redactor.py
├── setup.cfg
├── setup.py
└── tests/
    ├── test_names.py
    └── test_genders.py
    └── test_address.py
    └── test_concepts.py
    └── ...

setup.py

from setuptools import setup, find_packages

setup(
	name='project1',
	version='1.0',
	author='You Name',
	authour_email='your ou email',
	packages=find_packages(exclude=('tests', 'docs')),
	setup_requires=['pytest-runner'],
	tests_require=['pytest']	
)

Note, the setup.cfg file should have at least the following text inside:

[aliases]
test=pytest

[tool:pytest]
norecursedirs = .*, CVS, _darcs, {arch}, *.egg, venv

Tests

The general rule is you should aim to have a test for each feature. Including tests help people understand how your code works, in addition to verifying assumptions during development. Tests should be runnable by using pipenv run python -m pytest. If your tests cannot be run with the command above, you may lose points. You should discuss your tests in the README.

It is expected that you will use Spacy or Sklearn to complete this assignment. However, you are welcome to use other popular APIs. Some of these APIs a larger instance may require a larger instance, please let us know if you plan to do this. Also, some APIs require specialized keys, please let the TA know how you plan to use your keys. Below is the information for using Google tools.

Create a repository for your project on GitHub

Create a private repository GitHub called cs5293sp22-project1. Note that is the repository is public you may be considered academic dishonesty.

Add collaborators cegme, jasdehart by going to Settings > Collaborators.

We will be testing your code on the VM instances described in class. Please ensure your code runs correctly on the instances. If any extra information is necessary such as an extra large instance size you must specify that in your instances.

You should regularly git add <file>, git commit -m, and git push origin main your code changes to GitHub.

Submitting your code

When ready to submit, create a tag on your repository using git tag on the latest commit:

git tag v1.0
git push origin v1.0

Version v1.0 lets us know when and what version of code you would like us to grade. If you need to submit an updated version, you can use the tag v1.1. If you would like to submit a second version, use the tag v2.0.

If you need to update a tag, view the commands in the following StackOverflow post.

Grading

Grades will be assessed according to the following distribution:

Note we will be running your code in batch it is important that you follow directions closely

Make sure you

When submitting your project please quadruple check that you have done the following items. These will ensure you do not mistakenly lose points.

Addendum

pipeline = en_core_web_md.load()


- 2022-03-29 - Added an example of how to add spacy model to Pipfile and use it
- 2022-03-29 - There is a [bug in spaCy's version of click](https://github.com/explosion/spaCy/issues/10564) to fix it uninstall click and reinstall an older version.

  ```shell
  pipenv uninstall click
  pipenv install ‘click==8.0.0’

Back to Project List