Skip to main content

An OpenAI Gym environment for saturation provers

Project description

PyPI version CircleCI Documentation Status codecov

gym-saturation

gym-saturation is an OpenAI Gym environment for reinforcement learning (RL) agents capable of proving theorems. Currently, only theorems in CNF sublanguage of TPTP are supported. gym-saturation implements the 'given clause' algorithm (similar to one used in Vampire and E Prover). Although, being written in Python, gym-saturation is closer to PyRes. In contrast to monolithic architecture of a typical ATP, gym-saturation gives different agents opportunities to select clauses themselves and train from their experience. Combined with a particular agent, gym-saturation can work as an Automated Theorem Prover (ATP).

gym-saturation can be interesting for RL practicioners willing to apply their experience to theorem proving without coding all the logic-related stuff themselves. It also can be useful for automated deduction researchers who want to create an RL-empowered ATP.

How to Install

The best way to install this package is to use pip:

pip install gym-saturation

How to use

See the notebook for more information.

How to Contribute

Pull requests are welcome. To start:

git clone https://github.com/inpefess/gym-saturation
cd gym-saturation
# activate python virtual environment with Python 3.6+
pip install -U pip
pip install -U setuptools wheel poetry
poetry install
# recommended but not necessary
pre-commit install

To check the code quality before creating a pull request, one might run the script show_report.sh. It locally does nearly the same as the CI pipeline after the PR is created.

Reporting issues or problems with the software

Questions and bug reports are welcome on the tracker.

More documentation

More documentation can be found here.

Project details


Release history Release notifications | RSS feed

This version

0.1.1

Download files

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

Source Distribution

gym-saturation-0.1.1.tar.gz (40.3 kB view hashes)

Uploaded Source

Built Distribution

gym_saturation-0.1.1-py3-none-any.whl (54.3 kB view hashes)

Uploaded Python 3

Supported by

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