generated from tulane-cmps6730/sample-project
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
4f1e354
commit d3d959c
Showing
6 changed files
with
461 additions
and
1,734 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,26 +1,17 @@ | ||
# Your Terms: A text classifier that identifies potentially unfair or exploitative clauses in Terms and Conditions agreements | ||
|
||
It's no secret that | ||
- A simple web UI using Flask to support a demo of the project | ||
- A command-line interface to support running different stages of the project's pipeline | ||
- The ability to easily reproduce your work on another machine by using virtualenv and providing access to external data sources. | ||
It's no secret that peopledon't read their terms and conditions agreements. Rather than spending hours reading through dense legal document, a vast majority of people will simply click agree and move on with their day. That's why we built Your Terms, a text classifier that | ||
|
||
### Exeriments | ||
|
||
In the Notebooks module you can view all of the different experiments we ran. | ||
|
||
### Demo | ||
To run the demo: | ||
Move into the app directory with ```cd app``` | ||
Run the app with ```flask run``` | ||
This should run the flask app locally on your computer, so you should be able to use the demo at http://127.0.0.1:5000 (the port number may differ depending on your computer) | ||
|
||
Move into the app directory with by using ```cd app``` in your command line | ||
To run the app use ```flask run``` | ||
This should run the flask app locally on your computer, so you should be able to use the demo in your web browser at http://127.0.0.1:5000 (the port number may differ depending on your computer) | ||
Press ```ctrl + C``` in your command line to shut down the demo | ||
|
||
### Contents | ||
|
||
- [docs](docs): template to create slides for project presentations | ||
- [nlp](nlp): Python project code | ||
- [notebooks](notebooks): Jupyter notebooks for project development and experimentation | ||
- [report](report): LaTeX report | ||
- [tests](tests): unit tests for project code | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.