Skip to main content

An OpenAI Gym environment for saturation provers

Project description

PyPI version CircleCI Documentation Status codecov Binder

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

One also can run it in a Docker container:

docker build -t gym-saturation https://github.com/inpefess/gym-saturation.git
docker run -it --rm -p 8888:8888 gym-saturation jupyter-lab --ip=0.0.0.0 --port=8888 --no-browser

How to use

See the notebook or run it in Binder 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.3

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.3.tar.gz (41.9 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.3-py3-none-any.whl (56.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gym-saturation-0.1.3.tar.gz
  • Upload date:
  • Size: 41.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.11 CPython/3.6.15 Linux/5.11.0-27-generic

File hashes

Hashes for gym-saturation-0.1.3.tar.gz
Algorithm Hash digest
SHA256 ad5b15f5b040b04e0a2d71953e2db942ea4f20c8a9a0852bc62add0ac4b31034
MD5 4d7b9d9cb6bd321bcc4bb10881d21d29
BLAKE2b-256 5d1ff71c38d510e70ec775712251733d3e5b66749d143b194446c3118a2a7021

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for gym_saturation-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 fd4b749bef039e1b294d20bdc61b5d86facf1fcadc331ff274ce393793f8a428
MD5 ff4bb89c61cc59a5eb720519c20da595
BLAKE2b-256 dddc80478065dffc8f961890ddb4c39442eea74e9e084474d6f6bb75264ef4ca

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