ktr-skmt / FelisCatusZero-multilingual

This system answers world history essay questions in Japanese and/or English and evaluate the answers.
Apache License 2.0
4 stars 8 forks source link

FelisCatus Zero-multilingual

Build Status codecov License Gitter

This system answers world history essay questions in Japanese and/or English and evaluate the answers.

(past version: FelisCatus Zero.)

Trial

  1. Install Scala and Simple Build Tool (SBT).
  2. Git-clone or download this repository.
  3. Run trial.sh
    $ bash trial.sh

Quick Start Guide

(1) Software Installation for FelisCatus Zero Running

Install the following softwares before running (non-trial) FelisCatus Zero

Note: I am planning to make remote services to enable to run without local Indri and MeCab.

(2) Knowledge Source Installation

See Knowledge Source Installation

Note: Knowledge source accessible people are currently limited because of a license issue.
Note: I am planning to make remote services to enable to run without local knowledge sources.

(3) Download FelisCatus Zero

Git-clone or download this repository

Git-clone via HTTPS

cd (directory for downloading this repository)
git clone https://github.com/ktr-skmt/FelisCatusZero-multilingual.git

Git-clone via SSH

cd (directory for downloading this repository)
git clone git@github.com:ktr-skmt/FelisCatusZero-multilingual.git

Download

cd (directory for downloading this repository)
wget https://github.com/ktr-skmt/FelisCatusZero-multilingual/archive/master.zip

(4) Question-and-gold-standard Pair Installation

Sample questions have already been installed in this repository.

If you want to Install other pairs of question and gold standard, do the following 1. and/or 2.

  1. Put QA Lab-3 essay subtask datasets into src/main/resources/qalab_dataset
  2. Put QA Corpus into src/main/resources/qa_courpus

Note: I am planning to make remote services to enable to download training data and test data without installing them locally.

(5) How to Run

Run through SBT Shell (Recommended)

See How to Run through SBT Shell

Run through SBT Batch Mode

See Run.ipynb

Libraries

FelisCatusZero-multilingual has three libraries as sub-projects:

FelisCatusZero-multilingual is dependent on FelisCatus Zero-Libraries4JCas, FelisCatus Zero-Libraries4UIMA and JCas generated from FelisCatusZero's type system by JCasGen. FelisCatus Zero-Libraries4JCas is dependent on FelisCatus Zero-Libraries and FelisCatus Zero-Libraries4UIMA. The three libraries' dependencies are shown in the following table.

LIBRARY DEPENDENT on UIMA DEPENDENT on JCas generated from FelisCatusZero's type system
FelisCatus Zero-Libraries NO NO
FelisCatus Zero-Libraries4UIMA YES NO
FelisCatus Zero-Libraries4JCas YES YES

See build.sbt if you want to look in more detail.