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

Uploaded Python 3

File details

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

File metadata

  • Download URL: gym_saturation-1.0.3.tar.gz
  • Upload date:
  • Size: 16.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.0 CPython/3.13.2 Linux/6.14.0-29-generic

File hashes

Hashes for gym_saturation-1.0.3.tar.gz
Algorithm Hash digest
SHA256 cef2f6e804d8ba9d7ed5b3635924bfea6e0ad7fdb71cdb3bf30cf01811bbca33
MD5 bbac3b6ab14841f36d869361c95aea5e
BLAKE2b-256 4282186b2b1dd96a97936d734026d80c1c5fbbd82c208a27b69d616976172afe

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gym_saturation-1.0.3-py3-none-any.whl
  • Upload date:
  • Size: 22.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.0 CPython/3.13.2 Linux/6.14.0-29-generic

File hashes

Hashes for gym_saturation-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 789a5226e0ed5c890d53d2d448202faaa476181a9c6be8c5272dde5b13e84a85
MD5 549e81ce153038a8501a1d854aca8d81
BLAKE2b-256 9a616decdb9af57fdf4f41fbf029aae23799823e323d0171bb62e4af75600fee

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