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 -it --rm -p 8888:8888 gym-saturation jupyter-lab --ip=0.0.0.0 --port=8888

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 (a random action here)
    action = env.action_space.sample()
    observation, reward, terminated, truncated, info = env.step(action)
env.close()

Or have a look at the basic tutorial.

For a bit more comprehensive experiments, please see this project.

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

Uploaded Source

Built Distribution

gym_saturation-0.11.9-py3-none-any.whl (35.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gym_saturation-0.11.9.tar.gz
  • Upload date:
  • Size: 23.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.11.7 Linux/6.8.0-48-generic

File hashes

Hashes for gym_saturation-0.11.9.tar.gz
Algorithm Hash digest
SHA256 b693d27a168793b693fcd35d921257030dc22bec8fe273f876e5bad52f334017
MD5 2fe69baa7f55f190e39190d937304b87
BLAKE2b-256 06cafd22f6e928b058b050667db335beb9382316840e42c06123bc044b4c6b9e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gym_saturation-0.11.9-py3-none-any.whl
  • Upload date:
  • Size: 35.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.11.7 Linux/6.8.0-48-generic

File hashes

Hashes for gym_saturation-0.11.9-py3-none-any.whl
Algorithm Hash digest
SHA256 7a4c82d1e2ecd8ad9e952ed6ebca0f748368def74a80423ea7d274cdf2ebfb71
MD5 458b18aaaf1d9664ac74c162056db72b
BLAKE2b-256 4d9549414f8dcf40138f4014877754b208f1537c28e503c7dd71097c47585e40

See more details on using hashes here.

Supported by

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