Project System Documentation
For your group's final written deliverable I would like you to produce two documents
- a "System Report", intended to explain the problem your system intends to address and how it is handled in the final product
- an "Experience Report," which summarizes the 10 week process your team encountered.
Your documents should be placed in a three-ring binder with separate sections
for each document.
The System Report
Consider this to be similar to the professional research papers that you read during both AI and Intelligent Systems. This should be the report that explains exactly what your system does, how it does it, why it exists, and who might use your system (although not in that order).
You should write this document as though you were writing for a moderately well informed non-expert. That is, you should be able to hand this document to any faculty member in this department and (s)he would be able to understand what your system is and does even if they haven't taken an AI course since graduate school. Similarly, you should be able to hand this to a classmate from last fall's AI class and they should be able to follow the general idea about what you did (even if they have to go look up more details on neural networks/tensor flow or Monte Carlo techniques).
Model the structure and layout for this report as though it were a professional document submitted to a conference run by the ACM or IEEE or AAAI. That is, look back at some of the papers you read when you were getting started with your project.
This document should contain at least seven sections:
- an overview description of the system's purpose ("The abstract"). - This should include a
generalized description of the the system's overall functions, as
well as any commonly-encountered limitations (such as restricted
input formats). It is the two to three paragraph description of what your project is all about and it should stand on it' own.
- an explanation of the problem that is being "solved" and why this solution requires "intelligence." ("The motivation") - This is more than simply "we created a system that could play checkers and that requires intelligence because game playing is hard." Give detail on the problem being solved. Explain with some examples why it requires an "intelligent" human to solve it currently. Explain why solving this problem is important. Even if you think your problem is a "toy" problem you should be able to explain why it is related to other problems and meaningful in it's own right.
- an explanation of the overall system you have built. ("The system explained.") This is the largest section of your report and is likely multiple subsections. I am not telling you what those sections are because it will change from project to project. But make sure you take the time to figure this out for your project. In general this will explain IN DETAIL things such as :
- the input data to the system
- how it was pre-processed
- what happens to it when it is loaded into the system
- what techniques you use (e.g. "neural networks") and what configurations you currently employ (e.g. " an input layer of 50 nodes, three hidden layers of 40, 30, and 20 nodes respectively, and a final output layer of two nodes").
- how you arrived at that/those technique(s) and configurations (in short, the process)
- examples of how to use the system. ("The system demonstrated") This section should give several
detailed examples of system runs that demonstrate a substantial
fraction of the system's capabilities. Each example should provide
screen snapshots and other support material where appropriate.
- information on how a user or fellow reseracher would modify the system. ("The system's flexibility") This section should give information on what a user of your system could modify/change. Again, it should provide
screen snapshots and other support material where appropriate.
- an analysis on the "accuracy" or "quality" of your results ("System Analysis") - For some of you this is easy. You have specific training and testing data and you can report that your end system correctly predicts the results for 79% of your testing set. For others of you this is less easy. You have to compare the results of your final system to some other system which could be other public solutions ("Our agent scored N points when it played the game. Other researchers produced results of X, Y, and Z points.") or even to other versions of your own project ("Our final deliverable produced this poem. As you can see this appears to be of higher quality than alternate versions of our product which produced these poems") HOW you complete this section of your report will vary greatly depending on your project. But failure to address it will result in a decreased grade on this report.
- an explanation about how the problem you were working with provides meaningful results to the community at large ("Significance") - even if you feel you were working with a "toy" problem, the system you built is likely relatable to other non-toy problems and the lessons you learned could be used by more "serious" researchers. Address this idea in a clear and concise manner. In other words, sell the reader why your problem - even if toy - was worth studying.
The Experience Report
In the System Report you explained what your final project IS. In the Experience Report you explain what your project could have been.
Again, the format for this report is LARGELY dependent on your overall process and experience over the last 10 weeks. So in that regard it is hard to give you a specific rubric that I expect every group to follow. BUT, you also shouldn't underestimate the intentions of this report and fail to adequately address what I am looking for.
Depending on your experience this semester your experience report should have well labeled and organized sections that describe:
- what was the OVERALL process your group went through this semester? What did you try, for how long, and what went well or didn't go well.
- what techniques did you study this semester - not only the ones that made it into the final deliverable but everything you tried and considered.
- for each of the previous items - why did they work or not work? Why did you decide not to use it in the end (especially important for things that still might have worked but that you elected to cut for various reasons).
Notice that significant portions of these points MAY have been covered in your previous four sprint reports. But they were written "in the moment" and lacked any big picture context (what happened in the last two weeks regardless of what happened before or what is still yet to come). This time around you are writing about the whole semester in one document.
Additionally you should include sections that address
- if you still had five more weeks to work, what would you still want to do to improve your current project
- if you were going to take this project and use it as the basis for another project (maybe intelligent systems 2) what would you want to do next?
- if you could go back in time and have the "May version of your team" talk to the "January version of your team" what advice would you give yourselves.
Notice that while some of these points can be written from the point of view of you as an individual (and are in a separate document) this is all written from the team perspective.
Format of the Documents
The reports must be delivered in a standard three-ring binder. All pages must be numbered, except for the
title page and table of contents. The title page should contain the title
of the document, the names of the team members, the course name and
number, the instructor's name, the date the document is submitted, and
the department and school name. The table of contents should list all
sections and indicate the pages on which they begin. Sub-sections may
be listed if appropriate.
The sections of the document must be in the order listed above. Each
section should be marked to indicate the person(s) responsible for
Any bibliographic references used in these documents should follow a