Skip to main content

A high-level PDDL parsing and planning interface for implementing common classical planning algorithms.

Project description

AmenablePDDL

AmenablePDDL is designed to simplify parsing and planning simple PDDL-defined domains and problems, providing an intuitive interface for implementing common planning algorithms. AmenablePDDL is a wrapper around the PDDL library by Marco Favorito, Francesco Fuggitti, and Christian Muise.

This interface was developed for Carnegie Mellon University's 16-280 Intelligent Robotic Systems.

Table of Contents


Installation

  1. Clone or Download the repository containing AmenablePDDL.

  2. Install Dependencies:

    pip install pddl
    
  3. Include AmenablePDDL in your project by copying the module file or installing via your package manager if available.


Overview

AmenablePDDL provides a high-level interface for loading PDDL domain and problem files, managing states, binding action parameters, checking preconditions, applying effects, and more. It abstracts away the complexities of PDDL parsing and state manipulation, offering a streamlined set of methods for professional use.


Quick Start Example

from AmenablePDDL import AmenableP

# Initialize the interface with domain and problem files
interface = AmenableP("domain.pddl", "problem.pddl")

# Retrieve initial state and available actions
the_initial_state = interface.get_initial_state()
actions = interface.get_domain_actions()

print("Initial State:", the_initial_state)
print("Available Actions:", [action.name for action in actions])

This example initializes the AmenablePDDL interface, loads the domain and problem files, and prints out the initial state and available actions.


Public Methods

Constructor

interface = AmenableP(domain_file, problem_file)
  • domain_file: Path to the PDDL domain file.
  • problem_file: Path to the PDDL problem file.

Domain and Problem Access

  • get_domain_actions() -> List[Action]: Returns a list of Action objects defined in the domain.

State and Goal

  • get_initial_state() -> Set[Predicate]: Returns the set of positive predicates of the initial state.
  • is_goal_state(state: Set[Predicate]) -> bool: Checks if a given state satisfies the goal expression.

Action Retrieval

  • find_applicable_actions(state: Set[Predicate]) -> List[Tuple[Action, Dict[Variable, Constant]]]: Returns applicable actions with valid bindings in the given state.

Action Application

  • apply_action(action: Action, state: Set[Predicate], binding: Dict[Variable, Constant]) -> Set[Predicate]: Applies the specified action with the given binding to the state, returning a new state.

Implementing DFS (Example)

Below is an example of how to implement a Depth-First Search (DFS) planner using AmenablePDDL.

from AmenablePDDL import AmenableP

# Initialize the interface
interface = AmenableP("domain.pddl", "problem.pddl")

# Define a simple DFS function

def dfs(state, plan, visited, depth_limit):
    if depth_limit <= 0:
        return None
    if interface.is_goal_state(state):
        return plan

    visited.add(frozenset(state))

    for action, binding in interface.find_applicable_actions(state):
        new_state = interface.apply_action(action, state, binding)
        state_key = frozenset(new_state)

        if state_key not in visited:
            new_plan = plan + [(action, binding)]
            result = dfs(new_state, new_plan, visited, depth_limit - 1)
            if result is not None:
                return result
    return None

# Run DFS starting from the initial state
visited_states = set()
plan = dfs(interface.get_initial_state(), [], visited_states, depth_limit=50)

if plan:
    print("Plan found:")
    for step, (action, binding) in enumerate(plan, start=1):
        bound_str = " ".join(str(binding[param]) for param in action.parameters)
        print(f"{step}: {action.name} {bound_str}")
else:
    print("No plan found.")

This script initializes the AmenablePDDL interface, defines a recursive DFS function leveraging the interface's methods to find applicable actions and apply them, and then searches for a plan with a given depth limit.


Internal Methods (Optional)

AmenablePDDL also provides internal methods for advanced usage:

  • _evaluate_condition(expr, state, binding)
  • _find_bindings_for_action(action, state)
  • _apply_effects(action, state, binding)
  • _ground_predicate(pred, binding)

These methods are used internally by the public methods, but users can extend the existing methods by forking the repository.


License

This project is licensed under the MIT License. See the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

AmenablePDDL-0.1.2.tar.gz (4.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

AmenablePDDL-0.1.2-py3-none-any.whl (4.0 kB view details)

Uploaded Python 3

File details

Details for the file AmenablePDDL-0.1.2.tar.gz.

File metadata

  • Download URL: AmenablePDDL-0.1.2.tar.gz
  • Upload date:
  • Size: 4.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.8.16

File hashes

Hashes for AmenablePDDL-0.1.2.tar.gz
Algorithm Hash digest
SHA256 402a11a9914379b959d87289e73a2ed08dc5d22d6403b3b00b7f3b6741d365e5
MD5 af7da2b341112fe0411f1f9de5731ede
BLAKE2b-256 0699441b034908abddb612e1451324ac771bdf46fd0e2307e0c86185ac77cbb6

See more details on using hashes here.

File details

Details for the file AmenablePDDL-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: AmenablePDDL-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 4.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.8.16

File hashes

Hashes for AmenablePDDL-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 928419b229dfd9eaf086f6a33b54b1f494f17a18e4a9258063f968d22f029202
MD5 aee85d862fd44cd3e33d5b99f81f4c04
BLAKE2b-256 8f78dcb8d81d5ebcbec766908d8895bf1882db88a5fd39d93526677f419dc16d

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