Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Update README.md

  • Loading branch information...
commit 6326eca0b6cff082c9ff881d08a58c91335d77bd 1 parent 144b2c0
@sgrau authored
Showing with 41 additions and 2 deletions.
  1. +41 −2 README.md
View
43 README.md
@@ -1,2 +1,41 @@
-spindle-code
-============
+
+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
+ from automatic transcriptions]
+(http://blogs.oucs.ox.ac.uk/openspires/2012/06/29/automatic-keyword-generation-from-automatic-speech-to-text-transcriptions/).
+
+
+
+## How to use it
+
+** Usage: **
+
+ python keywords.py <text.txt>
+
+** Output: **
+
+
+ keyword-0 ll-0
+ keyword-1 ll-1
+ keyword-2 ll-2
+
+ bigram-0 n-appearances-bigram-0
+ bigram-1 n-appearances-bigram-1
+ bigram-2 n-appearances-bigram-2
+
+
+There are also a few parameters that could be tune to a given purpose.
+
+** 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)
+
+
+
+## Example:
+
+Text
Please sign in to comment.
Something went wrong with that request. Please try again.