Permalink
Browse files

Update README.md

  • Loading branch information...
1 parent 6326eca commit e5001219e948f5105bfca60266fa5596efc41f2a @sgrau committed Sep 10, 2012
Showing with 4 additions and 7 deletions.
  1. +4 −7 README.md
View
11 README.md
@@ -1,4 +1,3 @@
-
Keywords.py is a python script that generates keywords from a text.
It has been used during the [SPINDLE]
(http://openspires.oucs.ox.ac.uk/spindle/) project to [generate keywords
@@ -9,11 +8,11 @@ It has been used during the [SPINDLE]
## How to use it
-** Usage: **
+**Usage:**
python keywords.py <text.txt>
-** Output: **
+**Output:**
keyword-0 ll-0
@@ -25,14 +24,12 @@ It has been used during the [SPINDLE]
bigram-2 n-appearances-bigram-2
-There are also a few parameters that could be tune to a given purpose.
-
-** Parameters **
+**Parameters**
- nKeywords: number of keywords generated by the script (default 100)
- thresholdLL: log-likelihood value threshold (default 19)
- nBigrams: number of bigram generated by the script (default 25)
-- thresholdBigrams: minimun of appearances of a collocation (default 2)
+- thresholdBigrams: minimun of appearances of a bigram (default 2)

0 comments on commit e500121

Please sign in to comment.