/Planner-Carrier

A simple framework to run multiple planners in parallel.

Primary LanguagePython

icon standard-readme compliant

This is a simple framework to help testing vast AI planning benchmarks in parallel with multiple planners, collecting and analyzing data with customizable keywords. Done in pure Python.

Table of Contents

Background

In my honour year project about FOND planning, we have large numbers of benchmarks to test, get the results and analyze the data.The command of each planner to run one benchmark is very long because it includes the path of domain and problem files. First, we use shell script to run commands automatically for multiple benchmarks in series. But for some planners like SAT-based planner, it takes one hour to finish a benchmark frequently. In order to speed up the experiment, my supervisor and I wish to develop a simple framework for testing planning benchmarks parallelly on one machine or clusters. It will greatly improve the efficiency of the experiment, based on the computer CPU core numbers or clusters size. This is the original reason for this project. After finishing the framework, we add some additional features such as collecting and analyzing data to make the framework more useful.

Install

Prerequisites

  • Linux (tested on Ubuntu 20.04.1)
  • Python3.6 or above
  • Dask

Clone repo from GitHub

$ git clone https://github.com/lslll0302/Planner-Carrier.git

Install complete Dask

$ python -m pip install "dask[complete]"

Usage

Main Commands

  • Generate task: 
     python3 gentask.py
  • Run task: 
     python3 run.py [task.csv]
  • Process data: 
     python3 processdata.py [output folder] [list.txt]

Specific Details

Check more details in User Manual

Directory Structure

  • Database/:

    • path/: store relative path of corresponding domain and problem files for benchmarks
    • benchmarks.csv: a csv file includes names and problem sizes corresponding to all benchmarks in benchmarks/

  • benchmarks/: the current benchmarks of FOND planning (*.pddl)

  • planner/: the source code for the-state-of-art of FOND planners

    • Implemented: PRP, SAT
    • Not yet: MBP, myND, Gamer, FIP([Code+Sample Problems] can be found in the end of the publication: Fast strong planning for fully observable nondeterministic planning problems)

  • results/:

    • output/[task]/[planner]/: all standard output (stdout) of tested experiments stored in .txt files
    • data/[task]/[planner]/: all digitial data collected using corresponding key words stored in a .csv file for each benchamark
    • mean/[task]/[planner]/: the average of the data in data/ with customized sizes stored in .csv files
    • list/[task]/: all lists contain customized problems size that use for analyze output data stored in .txt files
      • for output/[task]/, data/[task]/ and mean/[task]/, each planner has its own /[planner] folder because each planner has different output data
      • but for list/[task]/, all planners use the shared list, so we don't need /[planner] folders

  • src/: including the code files to updat database, to create task file, to run the planning benchmarks , and to analyze the output data

    • task/: all created tasks stored in .txt files
    • utils.py: include all important realtive paths
    • gentask.py: updat database, and create task file
    • run.py: run the planning benchmarks on a single machine or cluster
    • processdata.py: process the output data of a task, catch numbers by keywords, calculate mean of catched numbers
    • planner.py: include class Planner(), contain methods to run planner, and analyze data. now we implement subclass PRP(Planner) and SAT(Planner)

Contributing

Feel free to dive in! Open an issue or submit PRs.

Acknowledgement

This project exists thanks to my supervisor Sebastian Sardina

License

MIT © Richard Littauer