Rollout: Complete JRoboExplorerSuite and Results Report
The final milestone includes both the complete code for all JRoboExplorer
software components and the written report described in
Section
. Both electronic and paper copies of the
report MUST be submitted. The goal of this milestone is to provide
the complete, functional JRoboExplorersuite, evidence that the JRoboExplorersuite
works as specified, and demonstration of the designer's explorations
and understanding of REINFORCEMENT LEARNING algorithms.
The deliverables for this milestone are:
- JRoboExplorersource code
- The complete Java source code for all
components of the JRoboExplorersuite, including all components delivered in
previous milestones and the AGENT, RL, and experimental code necessary
to complete the empirical testing.
- Test code
- All test code (JUnit and any additional
test code) used in testing JRoboExplorercomponents.
- Other Java source files
- Any additional files necessary to
compile and run the full JRoboExplorersuite and test codes.
- API Documentation
- The submission MUST include the full,
compiled JavaDoc documentation for all submitted Java modules.
This documentation MUST include full descriptions of
every public or protected method, field, sub-class, enclosed class, or
constructor employed by these modules. This documentation
hierarchy MUST be included in a sub-directory named
documentation/ within the submission jar file. You MAY use
the @inheritDoc Javadoc tag to include some of the
documentation from the cs351_f05_p2_support-v1.jardocumentation, but you MUST
explicitly state in the API documentation any deviation from, addition
to, or different assumptions than the original specifications.
- User documentation
- The submission MUST include a
USERDOC document that describes how to run your JRoboExplorersuite,
including how to select different environments, AGENTs, and learning
algorithms; how to set up and run experiments; how to run the
visualization component; etc. This
documentation MUST also include at least one example of how to run
each program and how to interpret the output. This document MUST be
named USERDOC.extension, but it MAY be be a plain text, HTML,
PDF, or PostScript document (with the appropriate extension).
It MUST NOT be a Microsoft Word or other nonportable format document.
- Empirical investigation report
- The report described in
Section
. Both paper and electronic copies MUST be
provided. The electronic copy MUST be included in the handin
.jar file. The electronic document MUST be named
EMPIRICAL.extension, but it MAY be be a plain text, HTML,
PDF, or PostScript document (with the appropriate extension).
It MUST NOT be a Microsoft Word or other nonportable format document.
The paper copy MUST be handed in at the beginning of class on Nov 8.
In addition, the handin MAY include any or all of the following:
- This file documents any updates to elements of
previous handins including what modules/files have changed, what substantial
functional changes were made to those modules/files, and whether the
instructors are asked to reevaluate those modules/files.
- This file documents any know missing features or
incomplete tests. It SHOULD also document what tests you would have
liked to include, but didn't, along with a description of why you did
not include them.
- This file includes any other notes or
documentation necessary to use or understand the submission that are
not already included in other documentation.
Terran Lane
2005-10-18