Skip to content

Latest commit

 

History

History
108 lines (63 loc) · 3.19 KB

README.md

File metadata and controls

108 lines (63 loc) · 3.19 KB

Data2sc-parser

About

This is a set of loaders and translators for extracting knowledge from external sources.

Supported external sources

  • WikiData
  • Google Search

How it works

You input entities to get from external source. Loader make requests to source and gives all info in JSON format. After that info in JSON translates to SCS and saves to directory you choose.

Requirements

For requirements installation use

pip3 install -r requirements.txt

NOTE

Install pip3 and libssl-dev before. For this use:

sudo apt install python3-pip

and

sudo apt install libcurl4-openssl-dev libssl-dev

About Wikipedia Tools

Recommend to use this version of Wikipedia tools.

To install use:

git clone https://github.com/Flombik/wptools.git
cd wptools
pip3 install -U .

Usage

Example

python3 src/parse.py Minsk Belarus "Belarusian State University of Informatics and Radioelectronics"
  • Input all entities titles with a space
  • Then type language of title with --lang attribute (by default its 'en')
  • Don't forget to choose directory for saving scs files and images. Make it with --dir attribute (by default its 'sc_out')
  • Select external source with attribute --source from 'wiki' and 'google' (by default its 'wiki')
  • If you want to get information about entity with context (relations with other entities and etc.) use --context (by default its 'False')
  • To get an intermediate JSON file use --debug (by default its 'False')

Example with attributes

python3 src/parse.py Минск --lang=ru --dir=output_dir --debug

For help enter

python3 src/parse.py --help

Architecture

Architecture of the parser looks like this:

Architecture

There is a base abstract class from which other translators are inherited. They implement the getEntity() method, adhering to a specific structure of a JSON file.

Structure of JSON file is displayed below:

JSON file structure

You can see 3 sections:

  • entities
  • relations
  • triplets

In entities section stores info about all entities which was loaded from external sources. Each entity include identifier, label and description. label and description include information in different languages. If loaded entity has image in image_url stores URL for loading this image.

In relations section stores info about relations. All the same as in entities section but relations usually don't have images.

In triplets section stores relations between entities. It is represented in form of triplets, where the first element is the entity from which a relation goes to the second entity. Second element is the relation that connect two entities. Third element is second entity.

After loading data JSON file translating by JsonToScsTranslator and all info saves to SCs files.

Example of SCs file you can see below:

SCs file example

Contribute

Pull requests are very welcome!

It would be great to hear your feedback and suggestions in the issue tracker!