diff --git a/README.md b/README.md index ee8f22f..5386661 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,18 @@ # AGROVOC autocoder -This Open-Ag auto-classification model is a product of +This Open-Ag auto-classification model is a product of [Foundation Center](http://foundationcenter.org/). It was developed -by Dave Hollander (dfh@foundationcenter.org) and Bereketab Lakew +by Dave Hollander (dfh@foundationcenter.org) and Bereketab Lakew (bkl@foundationcenter.org). This project uses Python 3.5.x in order to handle all -UTF-8 encoding issues. +UTF-8 encoding issues. -Training data for this model was obtained from +Training data for this model was obtained from [Food and Agriculture Organization of the United Nations](http://agris.fao.org/agris-search/index.do). The predictions are available for free via the `/text/ag_classification` REST API endpoint at [apibeta.foundationcenter.org](https://apibeta.foundationcenter.org/docs/v2.0/documentation.html#/README). -If you wish to host the model locally, the pre-trained models can be -[downloaded](https://s3.amazonaws.com/fc-public/svm/open_ag_models.zip), and +If you wish to host the model locally, the pre-trained models can be +[downloaded](https://s3.amazonaws.com/fc-public/svm/open_ag_models.zip), and should be stored in `src\model\clf_data\`. They can be served using the Flask server included in this project. @@ -26,10 +26,10 @@ supported in Windows): On Ubuntu: ./bootstrap.sh - + This will install Anaconda with Python 3, which includes dependent -libraries such as scikit-learn. - +libraries such as scikit-learn. + On MacOS: brew install qt @@ -37,24 +37,30 @@ On MacOS: pip3 install -U numpy scipy scikit-learn pip3 install -r requirements.txt - + If you already have Python 3, scikit-learn, NumPy and SciPy install you will only need to do pip install -r requirements.txt +You will also need to gect the nltk corpora data: + + python - <