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.5.tar.gz (22.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-0.11.5-py3-none-any.whl (35.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gym_saturation-0.11.5.tar.gz
  • Upload date:
  • Size: 22.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.11.7 Linux/6.5.0-17-generic

File hashes

Hashes for gym_saturation-0.11.5.tar.gz
Algorithm Hash digest
SHA256 a65d5a4be8f3191806de2d70b84b880d109fe77522d0c81d7bac6c788b60f85d
MD5 744a9e2f49f796c07ea3e60ddb1551ce
BLAKE2b-256 3ba5e376838023e3e6c027d01f3dc3cb35f398d8dd60480942f146173c473622

See more details on using hashes here.

File details

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

File metadata

  • Download URL: gym_saturation-0.11.5-py3-none-any.whl
  • Upload date:
  • Size: 35.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.11.7 Linux/6.5.0-17-generic

File hashes

Hashes for gym_saturation-0.11.5-py3-none-any.whl
Algorithm Hash digest
SHA256 beb7cdf2a7dea5a56c9f1ad0e361e4f96c8a8ffd62902a48701a943613e1974d
MD5 7faed2c55ac603067617b23254226caa
BLAKE2b-256 e571f04f1a2ee35cb4b3ab17ef9540a3404b2c8071c1971c6cb17ac972a2da92

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