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 details)

Uploaded Source

Built Distribution

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

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

Uploaded Python 3

File details

Details for the file gym-saturation-0.1.1.tar.gz.

File metadata

  • Download URL: gym-saturation-0.1.1.tar.gz
  • Upload date:
  • Size: 40.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.7 CPython/3.6.14 Linux/5.11.0-27-generic

File hashes

Hashes for gym-saturation-0.1.1.tar.gz
Algorithm Hash digest
SHA256 f82e58ada932987441ed226d9a7fca5bb87e578146ea6ddf5e67f74583efad5d
MD5 f3d5b0eff0fb660f1b75c0ccbd58256a
BLAKE2b-256 983fc5cc3e42b3a65d265fb9a394151e132d3029d8386b83a35b447548428751

See more details on using hashes here.

File details

Details for the file gym_saturation-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: gym_saturation-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 54.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.7 CPython/3.6.14 Linux/5.11.0-27-generic

File hashes

Hashes for gym_saturation-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 34705357945994562bf8ae691813d9d72037b9482b91205d20ad56573a4642d9
MD5 4e30b088e687ffdd9e8464196b60b2d4
BLAKE2b-256 61446053119a827c551a939527c4dfffbc89d4d267e31e9afe3d0d28323a855e

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