work on README

This commit is contained in:
Filip Gralinski 2018-06-12 09:10:11 +02:00
parent 1183966f4e
commit 590b3726cc

View File

@ -2,7 +2,9 @@
GEval is a Haskell library and a stand-alone tool for evaluating the GEval is a Haskell library and a stand-alone tool for evaluating the
results of solutions to machine learning challenges as defined on the results of solutions to machine learning challenges as defined on the
[Gonito](http://gonito.net) platform. [Gonito](http://gonito.net) platform. Also could be used outside the
context of Gonito.net challenges, assuming the test data is given in
simple TSV (tab-separated values) files.
Note that GEval is only about machine learning evaluation. No actual Note that GEval is only about machine learning evaluation. No actual
machine learning algorithms are available here. machine learning algorithms are available here.
@ -42,6 +44,16 @@ order to run `geval` you need to either add `$HOME/.local/bin` to
chmod u+x geval chmod u+x geval
./geval --help ./geval --help
## Examples
Let us download a Gonito.net challenge:
git clone git://gonito.net/sentiment-by-emoticons
The task is to predict the sentiment of a Polish short text -- whether
it is positive or negative (or to be precise: to guess whether a
positive or negative emoticon was used).
## Preparing a Gonito challenge ## Preparing a Gonito challenge
### Directory structure of a Gonito challenge ### Directory structure of a Gonito challenge