Updated:
- adding the tag “external-review” does not work (you do not the rights to, so just do not do it)
- link to springer (so not the journal version, but the conference version).
Project
The project is composed of three parts with a different deadline:
- the artifact (code you produced)
- a report
- the review of 2 artifacts produced by someone else
You should submitt all of the three parts to pass the course!
We will give the project on Thursday 1. of February we ended giving it out one week earlier on the 25th of January. Then you have 2
weeks for the artifact and one more week for the final report.
Dates
What? | When? |
---|---|
Artifact | Friday 16th of February (12:00) |
Report | Friday 23rd of February (23:59) |
Reviews | Friday 23rd of February (23:59) |
assigned on the 17th |
Themes
We are completely opened on what you write about. The only constraint is that you should go in depth on two themes from the lecture.
Some ideas:
- Develop a plugin for one of the text editors we discussed.
- Evaluate several plugins based on your specific use case and explain their differences and inner workings.
- Replicate a favorite book’s style in LaTeX.
- Automate analysis using Bash or Python.
- Implement automated testing for your side project, configure Git with hooks, and compare it to Jenkins.
- Conduct extensive LLM testing to assess differences.
- Create complex yet readable plots with gnuplot/jupyter.
Generally, just using the default option of a tool is not sufficient to claim having used a tool!
To Submit
As an example, we have written an example project. It is available in
our NextCloud under the Project
folder.
Report
The report should be:
- Approximately 6 to 10 pages long, excluding references and the table provided in the example project;
- It should be written in [LLNCS (Springer style)]https://resource-cms.springernature.com/springer-cms/rest/v1/content/19238648/data/v8)
- Include a table at the conclusion that showcases the sources utilized from the lecture (refer to the example project);
- Be written in either English or German;
- Address two topics discussed in the lecture.
- You should also submit the LaTeX sources of your project.
Artifact
As part of the report you will produce code / bash scripts. You should produce an artifact with a proper README that runs either
- under the following VM https://zenodo.org/records/7113223.
- or under docker
If you need extra proprietary software or Windows-specific software (Mathematica / Maple / …), please tell us early.
The artifact should include:
- a draft version of your paper;
- a license;
- include a proper README that shows what you have done and what part of the paper you are trying to produce. You are allowed to ask for installing extra software via the standard apt get;
- be runnable in less than 10 minutes. If it takes more than that, you should provide a small (meaningfull) subset of your input.
- you should not include the OVA image, only a folder
- the folder will be imported in the image (no shared folder)
- include the ouput your tool produces to be able to compare
Unlike the instructions on https://zenodo.org/records/7113223, you are allowed to use apt-get, but you should assume that you start with an empty virtual machine.
In the GitHub repository, mark the exact version you submitted with the artifact
tag.
Review
You will be assigned two artifacts by someone else. We will assign them on the 16th or 17th. You should write a small review including:
- a few sentence what the artifact is about
- whether you managed to reproduce what is done in the artifact and if that makes sense w.r.t. the results of the draft.
- some comments on the code
Some more information:
-
do not expect to get exactly the same timings, try a few to find how much faster/slower hardware is and see if you stay in the same ballpark.
-
we will use GitHub. Put the report in an issue.
We expect around half a page of review. However, you are not expected to debug or guess what the artifact is about.
You do not have to use the virtual machine… but if there are any problems, you need to check the virtual machine.