Skip to content

alexgalkin1994/wiki-en-to-simple

Repository files navigation

English to Simple English Wikipedia

Install

To start the programm Docker is required.

Build the containers with docker-compose build. Start them with docker-compose up. Navigate to http://localhost via your favorite web browser.

Usage

When you first open the tool you will see a search bar. Type in any topic you want annotate sentences for.

After you confirm your search you will get a list with all the topics related to your search term. The tool only shows topics that are available in English and Simple English. Click on the one you are interested in.

Now you can select any sentence in the English article (left side). The tool automatically matches your selected sentence based on semantic similarity to one or more sentence(s) in the Simple English article. Now you can either rate the matched sentence with the slider on the left side (0 - 3) or manually select/deselect sentences in the Simple English article. By clicking the Rate button under the slider you create a new entry in the database. An entry consists of the user score, algorithm score and the sentence pair. You can change between the three algorithms in the top left corner via the dropdown menu.

Connecting to the Database

The database can be accessed via Adminer http://localhost:8080 - just navigate to this adress in your web browser. Per default the server name is db and username and passwort are both root. You can find your annotations in the matchings_wiki database.

If you want to connect to the database via an external tool you can do it with the following adress: http://localhost:3308

Known Errors

If you encounter this error: ERROR: Service 'flask' failed to build: The command '/bin/sh -c pip install -r requirements.txt' returned a non-zero code: 137 then you have to allocate more RAM to Docker.