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.0

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.0.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.0-py3-none-any.whl (54.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gym-saturation-0.1.0.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.0.tar.gz
Algorithm Hash digest
SHA256 0fb2e57c687b8dd34b6a02cd2d8dc7af5da76366f86704115c53e312d91e0f15
MD5 88793642bcbc94740126474287142408
BLAKE2b-256 e4e5a193dc11581a9e4c9abe2a9673bd7dd812f60af8501c2b8a2a5db4c7aee7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gym_saturation-0.1.0-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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b47fd3b86cedb8cf21c09a14477c52cdbe066b263a6c580ec6eecb70f98f742c
MD5 623a2f03edb5192d655a06c5786615a6
BLAKE2b-256 93388f8bdaa8ddd4df59df397c99aa2d119ee77ca6a04c77fe65f3c25293bbb1

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