EbookFoundation
/
oapen-suggestion-service
mirror of https://github.com/EbookFoundation/oapen-suggestion-service.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
oapen-suggestion-service/oapen-engine
History
Celina Peralta dab7812da4
Merge branch 'main' into celinanperalta/OAP-60 		2023-04-03 17:03:28 -04:00
..
scripts OAP-61: flatten suggestions database (#46) 2023-04-03 17:02:16 -04:00
src Merge branch 'main' into celinanperalta/OAP-60 2023-04-03 17:03:28 -04:00
.gitignore Fix makefile for linux and variable python (#27) 2022-12-04 21:54:40 -05:00
Dockerfile Basic testing (#45) 2023-03-22 14:52:38 -04:00
Makefile Basic testing (#45) 2023-03-22 14:52:38 -04:00
Pipfile add schedule package to daemon (#48) 2023-03-31 15:33:41 -04:00
README.md OAP-56 and logging (#38) 2023-03-06 14:44:45 -05:00
pipenv-proper-names.txt Create mining engine boilerplate (#2) 2022-09-27 15:07:50 -04:00
pyvenv.cfg OAP-22: Set up python build job in GH actions (#4) 2022-09-30 15:49:04 -04:00

README.md

OAPEN Suggestion Service

Getting Started

Running the application

Ensure that you have followed the setup instructions in the top level README, then run:

docker-compose up --build

Cleaning the database manually

./scripts/clean.sh

Refreshing items + suggestions manually

./scripts/refresh.sh

How to remove/filter out bad ngrams

Members of EbookFoundation can create a pull request to edit the stopwords used to filter out bad trigrams:

oapen-engine/src/model/stopwords_*.txt

This also can be done to remove a malformed trigram already in the database (during the next run)