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 then naviagate to http://localhost:8888/lab/tree/example.ipynb 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.0.tar.gz (17.2 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.0-py3-none-any.whl (22.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gym_saturation-1.0.0.tar.gz
  • Upload date:
  • Size: 17.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.2 CPython/3.12.7 Linux/6.11.0-21-generic

File hashes

Hashes for gym_saturation-1.0.0.tar.gz
Algorithm Hash digest
SHA256 e70b6250c917ecaf7a9a1d91aa78c491e0dac40c6b7e664e33a34e2ec09efc04
MD5 fc9dd8a15faf64512eebe554940ee437
BLAKE2b-256 1c823facb0de5cb4b488a8e431f53e4489e4e0e64e63c68c628af98a1322ebcc

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for gym_saturation-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 653cb9109ffe5921e4de4b8652bd89f7fe94ad7af4338b82a307aa8796a8aa07
MD5 e026d35d0800be8e53e80825405f62c1
BLAKE2b-256 bfe64497aadc1274d3f4d3bddb6cb8d61e5b88ed32d89bcf1d6a9f8403bc5753

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