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.12.1.tar.gz (22.7 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.12.1-py3-none-any.whl (35.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: gym_saturation-0.12.1.tar.gz
  • Upload date:
  • Size: 22.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.12.7 Linux/6.8.0-51-generic

File hashes

Hashes for gym_saturation-0.12.1.tar.gz
Algorithm Hash digest
SHA256 7308e6b3e1a9d8fedf58faf148d5775e4f8b885ac3b1230b4c9cc572dfb35876
MD5 cc6b3f3734cda9bfebc924b288db69d3
BLAKE2b-256 9eb6667c5a52a6f2c25fa506fde146759a6686d5e914879e0f7f18e8540f8dbc

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for gym_saturation-0.12.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f4b28d85aca50535f7a8e93c484e6c17cc8651830cef00551f385c8c5871f505
MD5 8db6ffa541db3ea5cfcf2c77e4ae132d
BLAKE2b-256 8a6abc3a9f7b4998ba8714ad7c248c0b859979e30ee804bf730d6912a2ab9408

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