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 practitioners 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.2

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.2.tar.gz (40.5 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.2-py3-none-any.whl (54.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for gym-saturation-0.1.2.tar.gz
Algorithm Hash digest
SHA256 d44ffdf646b708fa66b5287b6cc3d109d497d5f5f3e5c5067236f4817bca72ed
MD5 aeecc1a841dc4a6066a722109cbb024c
BLAKE2b-256 573eb49e892549f6c27ba0237048dbd4ba71b3ac06a8b0399bfb06d8d375aa4c

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for gym_saturation-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 69a029c5e801e4a2047fbc78486253353f65e06ce89cf9ad4dc45096e6524bdf
MD5 5cb27219a8fcdab3691a9868097ae114
BLAKE2b-256 c98a878ed15129d5794a8380bcaaa2df533e6cc837cb39d510bd576835dcaf82

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