Machetli

Machetli is a Python package for reproducing characteristics of a program (such as bugs) with modified instances. It is meant to be helpful for debugging complex programs and narrowing down where specific behaviors are caused.

Currently, Machetli handles instances for automated planners, specified either in PDDL or in the SAS⁺ format used by Fast Downward but adding support for other file formats is easy.

Installation

Machetli requires Python 3.7+ and can be installed with pip.

pip install machetli

If you want to avoid changes to your system-wide Python installation you can install Machetli in a virtual Python environment.

Usage

An interactive demo of Machetli is available as a Jupyter notebook on Google Colab. You can find additional examples in the directory examples.

For a more detailed description, please refer to the documentation.

Support

• Documentation: https://machetli.readthedocs.io

• Issue tracker: https://github.com/aibasel/machetli/issues

• Code: https://github.com/aibasel/machetli

License

Machetli is licensed under GPL3.

User Documentation

• Installation
• Overview
  • Search
  • States
  • Successor Generators
  • Evaluators
• Usage
  • Writing an evaluator script
  • Writing the search script
    • Running the search on a grid
  • Examples
• Extending Machetli
  • Adding a new successor generator
    • Example: removing goal conditions
  • Supporting a new file type
    • Example: finding bugs in LaTeX documents

API Documentation - Planning

• machetli.pddl — PDDL Files
• machetli.sas — SAS⁺ Files

API Documentation - General

• machetli
• machetli.environments
• machetli.evaluator
• machetli.successors
• machetli.tools

Meta Documentation

• Documentation Guide