Skip to main content

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

Project description

PyReason

Python Build Python version compatibility

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

Links

Paper: https://arxiv.org/abs/2302.13482

Video: https://www.youtube.com/watch?v=E1PSl3KQCmo

Website: https://neurosymbolic.asu.edu/pyreason/

PyReason Gym: https://github.com/lab-v2/pyreason-gym

Check out the PyReason Hello World program if you're new, or want get get a feel for the software.

Table of Contents

  1. Introduction
  2. Install
  3. Usage
  4. Bibtex
  5. License
  6. Contact

1. Introduction

PyReason makes use of 4 files:

  1. A GraphMl file containing the graph (required)
  2. A YAML file containing the pyreason rules (required)
  3. A YAML file containing the pyreason facts (optional but recommended)
  4. A YAML file containing the pyreason labels (optional but recommended)
  5. 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

  1. Usage as Python Library
  2. Usage as a Command Line Tool

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}}

5. License

This repository is licensed under BSD-3-Clause

6. Contact

Dyuman Aditya - dyuman.aditya@asu.edu

Kaustuv Mukherji - kmukher2@asu.edu

Paulo Shakarian - pshak02@asu.edu

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyreason-1.5.1.tar.gz (37.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyreason-1.5.1-py3-none-any.whl (48.5 kB view details)

Uploaded Python 3

File details

Details for the file pyreason-1.5.1.tar.gz.

File metadata

  • Download URL: pyreason-1.5.1.tar.gz
  • Upload date:
  • Size: 37.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for pyreason-1.5.1.tar.gz
Algorithm Hash digest
SHA256 47325158ae8f650a9b627c0d83fceb2c54ec19dbacacae0aecce80531d8aa333
MD5 9bba2d8b5159d20d8d99f3519bb697cc
BLAKE2b-256 829507259d0e0fbe92458ea22062157f41f97734a4d62df0513fe6edce34d8d4

See more details on using hashes here.

File details

Details for the file pyreason-1.5.1-py3-none-any.whl.

File metadata

  • Download URL: pyreason-1.5.1-py3-none-any.whl
  • Upload date:
  • Size: 48.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.16

File hashes

Hashes for pyreason-1.5.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a052aa5c389922ac6ee8dd57d6e6a9df28059fa8f54c44bf0883676a5296a054
MD5 282729d0be3e56ac33e72781d4d3622f
BLAKE2b-256 6e6c33ce47c7996afc68d929a994e75f11246a21f969f480211e40eac119e0ae

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page