# adam_qas

**Repository Path**: donfar/adam_qas

## Basic Information

- **Project Name**: adam_qas
- **Description**: ADAM - A Question Answering System. Inspired from IBM Watson
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-06-17
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ADAM -- Question Answering System

[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/2e669faacb12496f9d4e97f3a0cfc361)](https://www.codacy.com/app/5hirish/adam_qas?utm_source=github.com&utm_medium=referral&utm_content=5hirish/adam_qas&utm_campaign=badger)
[![Codecov](https://codecov.io/gh/5hirish/adam_qas/branch/master/graph/badge.svg)](https://codecov.io/gh/5hirish/adam_qas)
[![Build Status](https://travis-ci.org/5hirish/adam_qas.svg?branch=master)](https://travis-ci.org/5hirish/adam_qas)
[![Gitter](https://badges.gitter.im/alleviatenlp/adam_qas.svg)](https://gitter.im/alleviatenlp/adam_qas?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
[![Twitter](https://img.shields.io/twitter/follow/openebs.svg?style=social&label=Follow)](https://twitter.com/intent/follow?screen_name=5hirish)

A question answering system that extracts answers from Wikipedia to questions posed in natural language.
Inspired by *IBM Watson* and *START*.
We are currently focused on improving the accuracy of the extracted answers.
Follow the creator's blog at [shirishkadam.com](https://www.shirishkadam.com/) for updates on progress.

## Getting Started

Elasticsearch is being used to store and index the scrapped and parsed texts from Wikipedia.
`Elasticsearch 7.X` installation guide can be found at [Elasticsearch Documentation](https://www.elastic.co/guide/en/elasticsearch/reference/current/_installation.html). 
You might have to start the elasticsearch search service.

```bash
$ git clone https://github.com/5hirish/adam_qas.git
$ cd adam_qas
$ pip install -r requirements.txt
$ python -m qas.adam -vv "When was linux kernel version 4.0 released ?"
```

_Note:_ The above installation downloads the best-matching default english language model for spaCy. But to improve the model's accuracy you can install other models too. Read more at [spaCy docs](https://spacy.io/usage/models).

```bash
$ python -m spacy download en_core_web_md
```

## Running with Docker

```bash
$ git clone https://github.com/5hirish/adam_qas.git
$ cd adam_qas
$ docker-compose up
```

Now both conntainers are up and running.
Next step is to enter in the python container and run Adam:

```bash
$ docker exec -it $(docker ps -a -q  --filter ancestor=adam_qas_adam) bash
$ python -m qas.adam -vv "When was linux kernel version 4.0 released ?"
```


## References

Find more in depth documentation about the system with its research paper and system architecture [here](docs/ARCHI.md)

## Requirements

* [Python 3.X](https://docs.python.org/3/)
* [Elasticsearch 7.X](https://www.elastic.co/guide/en/elasticsearch/reference/current/_installation.html)

Python Package dependencies listed in [requirements.txt](requirements.txt)
Upgrading Elasticsearch 6.X:
 - Rolling Update 6.2 to 6.8 > [ref](https://www.elastic.co/guide/en/elasticsearch/reference/6.8/rolling-upgrades.html)
 - Rolling Update 6.8 to 7.1 > [ref](https://www.elastic.co/guide/en/elasticsearch/reference/current/rolling-upgrades.html)
### Features

* Extract information from Wikipedia
* Classify questions with regular expression (default)
* Classify questions with a SVM (optional)
* Vector space model used for answer extraction
* Rank candidate answers
* Merge top 5 answers into one response

#### Current Project State ?
[GitHub Issue #36: Invalid Answers](https://github.com/5hirish/adam_qas/issues/36)

### TODO

- [x] Replace Wikipedia APIs with custom scraper
- [x] Storing extracted data in database (elasticsearch)
- [x] SQLite test input data storage
- [ ] Anaphora resolution in both questions and answers
- [ ] Machine learning query constructor rather than rule-based
- [ ] Improve vector space language model for answer extraction

### Contributions
Please see our [contributing documentation](docs/CONTRIBUTING.md) for some tips on getting started.

### Maintainers
* [@5hirish](https://github.com/5hirish) - Shirish Kadam