Skip to main content

Gymnasium environments for saturation provers

Project description

PyPI versionAnacondaCircleCIDocumentation StatuscodecovDOI

gym-saturation

gym-saturation is a collection of Gymnasium environments for reinforcement learning (RL) agents guiding saturation-style automated theorem provers (ATPs) based on the given clause algorithm.

There are two environments in gym-saturation following the same API: SaturationEnv: VampireEnv — for Vampire prover, and IProverEnv — for iProver.

gym-saturation can be interesting for RL practitioners willing to apply their experience to theorem proving without coding all the logic-related stuff themselves.

In particular, ATPs serving as gym-saturation backends incapsulate parsing the input formal language (usually, one of the TPTP (Thousands of Problems for Theorem Provers) library), transforming the input formulae to the clausal normal form, and logic inference using rules such as resolution and superposition.

How to Install

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

pip install gym-saturation

Another option is to use conda:

conda install -c conda-forge gym-saturation

One can also run it in a Docker container (pre-packed with vampire and iproveropt binaries):

docker build -t gym-saturation https://github.com/inpefess/gym-saturation.git
docker run --rm -p 8888:8888 --name gym-saturation -d gym-saturation

and navigate to http://localhost:8888/lab/tree/example.py in your browser.

How to use

One can use gym-saturation environments as any other Gymnasium environment:

import gym_saturation
import gymnasium

env = gymnasium.make("Vampire-v0")  # or "iProver-v0"
# skip this line to use the default problem
env.set_task("a-TPTP-problem-filename")
observation, info = env.reset()
terminated, truncated = False, False
while not (terminated or truncated):
    # apply policy
    action = ...
    observation, reward, terminated, truncated, info = env.step(str(action))
env.close()

Have a look at the basic tutorial.

More Documentation

More documentation can be found here.

How to Contribute

Please follow the contribution guide while adhering to the code of conduct.

How to Cite

If you are writing a research paper and want to cite gym-saturation, please use the following DOI.

Project details


Release history Release notifications | RSS feed

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-1.0.2.tar.gz (16.7 kB view details)

Uploaded Source

Built Distribution

gym_saturation-1.0.2-py3-none-any.whl (22.7 kB view details)

Uploaded Python 3

File details

Details for the file gym_saturation-1.0.2.tar.gz.

File metadata

  • Download URL: gym_saturation-1.0.2.tar.gz
  • Upload date:
  • Size: 16.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.12.7 Linux/6.14.0-15-generic

File hashes

Hashes for gym_saturation-1.0.2.tar.gz
Algorithm Hash digest
SHA256 7b4afc09ed09df638d25338e8c225e4dc446f83e479d57c132f8c5d2efddd8bf
MD5 712597ba1c32bb9e5ebaa79f193cc6e1
BLAKE2b-256 8886605c0b51a3baa9731bd10990b179cb2c09c24065084e6ac2dbcade7ebd48

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gym_saturation-1.0.2-py3-none-any.whl
  • Upload date:
  • Size: 22.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.12.7 Linux/6.14.0-15-generic

File hashes

Hashes for gym_saturation-1.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 4208e33a6d0ebaff1298f250afda97d7efc30dddb6842a37ce94dddf5aedc821
MD5 3fd7fb5cfba6b5fc11fe85fa5104a516
BLAKE2b-256 9e825d7e751ed0fe014cf74139d21b475c2a171f5caa15f11ba19d1f2bb03e3b

See more details on using hashes here.

Supported by

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