ilyamk / pyreason Goto Github PK

View Code? Open in Web Editor NEW

This project forked from lab-v2/pyreason

An explainable inference software supporting annotated, real valued, graph based and temporal logic

License: BSD 3-Clause "New" or "Revised" License

Shell 0.65% Python 99.35%

pyreason's Introduction

PyReason

An explainable inference software supporting annotated, real valued, graph based and temporal logic.

1. Introduction

PyReason makes use of 4 files:

A GraphMl file containing the graph (required)
A YAML file containing the pyreason rules (required)
A YAML file containing the pyreason facts (optional but recommended)
A YAML file containing the pyreason labels (optional but recommended)
A YAML file containing the pyreason ipl (inconsistent predicate list) (optional)

The format of these files is very important. Please refer to the example YAML files provided when making your own rules/facts/labels/ipl. TODO: make doc for each format.

2. Install

PyReason can be installed as a python library (recommended) or as a command line tool

2.1 Install as a Python Library

We import pyreason to initialize it for the first time, this may take a few minutes

pip install pyreason
python
import pyreason

2.2 Install as a Command Line Tool

git clone https://github.com/lab-v2/pyreason
cd pyreason
pip install -r requirements.txt
python initialize.py

3. Usage

Please refer to the documentation that is relevant to you

4. Bibtex

If you used this software in your work please cite our paper

Bibtex:

@inproceedings{aditya_pyreason_2023,
title = {{PyReason}: Software for Open World Temporal Logic},
booktitle = {{AAAI} Spring Symposium},
author = {Aditya, Dyuman and Mukherji, Kaustuv and Balasubramanian, Srikar and Chaudhary, Abhiraj and Shakarian, Paulo},
year = {2023}}