build details

Show: section status errors & todos local changes recent changes last change in-page changes feedback controls

Group name: final report

Modified 2019-12-11 by tanij

Before starting, you should have a look at some tips on how to write beautiful Duckiebook pages (unknown ref duckumentation/contribute)

previous warning next (4 of 7) index
warning
I will ignore this because it is an external link. 

 > I do not know what is indicated by the link '#duckumentation/contribute'.

Location not known more precisely.

Created by function n/a in module n/a.
.

The objective of this report is to bring justice to your extraordinarily hard work during the semester and make so that future generations of Duckietown students may take full advantage of it. Some of the sections of this report are repetitions from the preliminary design document (PDD) and intermediate report you have given.

The final result

Modified 2019-12-11 by tanij

Let’s start from a teaser.

  • Post a video of your best results (e.g., your demo video): remember to have duckies on the robots or something terrible might happen!

Add as a caption: see the operation manual to reproduce these results. Moreover, add a link to the readme.txt of your code.

Mission and Scope

Modified 2019-12-11 by tanij

Now tell your story:

Define what is your mission here.

Motivation

Modified 2019-12-11 by tanij

Now step back and tell us how you got to that mission.

  • What are we talking about? [Brief introduction / problem in general terms]

  • Why is it important? [Relevance]

Existing solution

Modified 2019-12-11 by tanij

  • Was there a baseline implementation in Duckietown which you improved upon, or did you implemented from scratch? Describe the “prior work”

Opportunity

Modified 2019-12-11 by tanij

  • What was wrong with the baseline / prior work / existing solution? Why did it need improvement?

Examples: - there wasn’t a previous implementation - the previous performance, evaluated according to some specific metrics, was not satisfactory - it was not robust / reliable - somebody told me to do so (/s) (this is a terrible motivation. In general, never ever ever say “somebody told me to do it” or “everybody does like this”)

  • How did you go about improving the existing solution / approaching the problem? [contribution]

Examples: - We used method / algorithm xyz to fix the gap in knowledge (don’t go in the details here) - Make sure to reference papers you used / took inspiration from, lessons, textbooks, third party projects and any other resource you took advantage of (check here how to add citations in this document). Even in your code, make sure you are giving credit in the comments to original authors if you are reusing some components.

Preliminaries

Modified 2019-12-11 by tanij

  • Is there some particular theorem / “mathy” thing you require your readers to know before delving in the actual problem? Briefly explain it and links for more detailed explanations here.

Definition of link: - could be the reference to a paper / textbook - (bonus points) it is best if it is a link to Duckiebook chapter (in the dedicated “Preliminaries” section)

Definition of the problem

Modified 2019-12-11 by tanij

Up to now it was all fun and giggles. This is the most important part of your report: a crisp, possibly mathematical, definition of the problem you tackled. You can use part of the preliminary design document to fill this section.

Make sure you include your: - final objective / goal - assumptions made - quantitative performance metrics to judge the achievement of the goal

Contribution / Added functionality

Modified 2019-12-11 by tanij

Describe here, in technical detail, what you have done. Make sure you include: - a theoretical description of the algorithm(s) you implemented - logical architecture - software architecture - details on the actual implementation where relevant (how does the implementation differ from the theory?) - any infrastructure you had to develop in order to implement your algorithm - If you have collected a number of logs, add link to where you stored them

Feel free to create subsections when useful to ease the flow

Formal performance evaluation / Results

Modified 2019-12-11 by tanij

Be rigorous!

  • For each of the tasks you defined in you problem formulation, provide quantitative results (i.e., the evaluation of the previously introduced performance metrics)
  • Compare your results to the success targets. Explain successes or failures.
  • Compare your results to the “state of the art” / previous implementation where relevant. Explain failure / success.
  • Include an explanation / discussion of the results. Where things (as / better than / worst than) you expected? What were the biggest challenges?

Future avenues of development

Modified 2019-12-11 by tanij

Is there something you think still needs to be done or could be improved? List it here, and be specific!