Skip to content

Commit e721fff

Browse files
committed
Add basic readme
1 parent 2b43e10 commit e721fff

1 file changed

Lines changed: 12 additions & 0 deletions

File tree

src/nlp/README.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Natural Language Processing Library
2+
3+
This library provides tool for performing natural language processing on websites.
4+
This library is in it's infancy currently and can only be used for testing.
5+
6+
To test gathering data use:
7+
`python3 gater_data.py`
8+
* This will generate the data necessary to train the classification model
9+
10+
To predict the classification of a webiste use:
11+
`python3 main.py -website https://www.github.com`
12+
* Add `-accuracy` argument, to view the accuracy of the prediction

0 commit comments

Comments
 (0)