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.4.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.4-py3-none-any.whl (22.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gym_saturation-1.0.4.tar.gz
  • Upload date:
  • Size: 16.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.13.3 Linux/6.17.0-8-generic

File hashes

Hashes for gym_saturation-1.0.4.tar.gz
Algorithm Hash digest
SHA256 20a56ba7fdda500a94533e8a2def7b34148d28807caf7c1e76776c41d8a5bf3f
MD5 b77b6272f19cd82817f98ebd2bdcb4eb
BLAKE2b-256 948b71c8998869e071d9ca1b780f56a1a8a60040c4355338c6ae5576da454738

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gym_saturation-1.0.4-py3-none-any.whl
  • Upload date:
  • Size: 22.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.2.1 CPython/3.13.3 Linux/6.17.0-8-generic

File hashes

Hashes for gym_saturation-1.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 dc25dce8536eacdcb979be02aebd411e31e4c8d2534f581915194f5bb0c1eb98
MD5 fb06d47eb032662d0849bb99796aa06d
BLAKE2b-256 d6421b2b718fb89eef434e7fb6bd17ed7f3a9a064e224dbaaf4c96fc3925167d

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