Built off of the open-source JavaFF2.1 project as a part of my individual project venturing into Goal Serialisation and Heuristic-based goal ordering.
In order to build the artefact, first install the following
- Java 11, through Oracle or OpenJDK,
- Gradle 6.4, instructions can be found here.
In order to build a fresh copy of the artefact, move into the /gsFF subdirectory:
cd gsFF
And run:
gradle clean && gradle build
This will build an executable jar into /build/lib.
The built artefact can be used by running the following:
java -jar gsFF.jar -g -o <domain> -f <problem>
Running this command without any options will output a list of viable options as well as the bare minimum required options.
The artefact can be ran with the following command-line options:
| Option | Description |
|---|---|
-o, --domain <domain> |
(required) domainFile.pddl |
-f, --problem <problem> |
(required) problemFile.pddl |
-w, --output <output> |
outputFile.plan |
| -g, --goal-serialisation | Goal serialisation? |
-h, --heuristic <heuristic> |
Heuristic to use with goal serialisation in ordering goals. (default: NONE) |
Where heuristic is one of the following:
| Heuristics | Description |
|---|---|
| NONE | Given goal order |
| RANDOM | Random goal order |
| RPGASCENDING | Pre-planning RPG-based ascending order |
| RPGDESCENDING | Pre-planning RPG-based descending order |
| INRPGASCENDING | In-planning RPG-based ascending order |
| INRPGDESCENDING | In-planning RPG-based descending order |
Gradle is packaged with tasks for the 5 domains on which the planner tested on. To view all gradle tasks, run:
gradle tasks --all
The most basic gradle task, which runs the baseline implementation of JavaFF is:
gradle <domain>-<problem>
| Domains |
|---|
| rovers |
| elevators |
| satellite |
| driverlog |
| freecell |
To specify heuristics, use the following format:
gradle <domain>-<heuristic>-<problem>
With the following heuristics:
| Description | heuristic |
|---|---|
| Only goal serialisation | gs |
| Random | gs-rand |
| Pre-planning RPG Ascending | gs-rpg-asc |
| Pre-planning RPG Descending | gs-rpg-asc |
| In-planning RPG Ascending | gs-in-rpg-asc |
| In-planning RPG Ascending | gs-in-rpg-asc |
For most problems, the <problem> parameter is a number ranging from 1-20, but in the case of the Elevators domain, the <problem> parameter is specified as two numbers between 1-30 and 0-4 respectively, separated by a hyphen. For example, 1-0, 1-4, ..., 30-0, 30-4.
The Freecell domain also has additional problems which can be specified using a similar format, but with numbers between 2-13 and 1-5 respectively. For example, 2-1, 2-5, ..., 13-1, 13-5.
Packaged with the source code is the test script run_tests.py used to gather performance data. The script has a suite of functions which can be used in varying ways to test domains and record the data produced.
Please note that this script is not a command-line tool and must be modified as required prior to execution.