This is an old revision of the document!
Table of Contents
How to Write a Master's Thesis
NLP Master's Thesis from Enrollment to Defense
This tutorial could also be called “things I wish I had known when I was writing my diploma thesis”
. This guideline is intended to ease writing your master's thesis (and hopefully, to produce better theses and successful defenses, as a result) and what better way is there than provide you with a spectrum of information I gained being on both sides of the trench. I'm going to navigate you through the process of your master's thesis assignment, writing and defense. The guideline is mostly fitted to a typical experimental NLP master's thesis (at ÚFAL) but I'm sure you can tweak it to other situation once you get the general idea.
Timeline
I don't think I can emphasize enough: start EARLY. Seriously. You will make your life much easier if you start programming, measuring and writing (that especially!) in good time. Most opponents can recognize hasty writing hurriedly finished over the last week before deadline. As for the question what is the minimum time in which I can write a thesis
, let's pretend I never heard the question.
The exact dates of everything that happens at the Faculty of Mathematics and Physics, such as beginnings and ends of semesters, deadlines for courses and exams enrollments, deadlines for theses submissions and theses exams, is strictly bound by an official Academic Calendar of the faculty. Look out for the exact deadlines of the required actions in the current version.
With that in mind, let's say that a typical master's curriculum takes two academic years (four semesters). Master's thesis writing is officially a three-semester course, consisting of three subsequent (!) semesters each of which you must subscribe to in the Study Information System (SIS), in the appointed deadline. ML: ALE to není oficiámní požadavek a často si studenti zapíší všechny tři kurzy až najednou na konci čtvrtého semestru; navíc v akad. kalendáři je doporučení vybrat si diplomku až v listopadu 2. roku (což je zejména důležité pro LCT studenty).
ML: However, this ideal timetable is not applicable in all case, especially, e.g., for LCT students who spend one year abroad - LCT students typically select the topic at the beginning of their second year, i.e. during October (note that those doing their second year at another university still must find a co-supervisor from Prague.
That generates roughly the following course of action:
- 1st year winter semester: Starting your first semester as a master's student. Before the end of this semester, start looking around for a possible topic of your thesis. PRESUN NIZ
There are two ways to select your topic:
- You can go to the module Thesis (Selection of subject) in the Study Information System (SIS) which lists an offer of yet unsubscribed theses. If any of them catches your eye, contact the supervisor by e-mail.
- If you have a cool topic in mind, you can also approach a prospective supervisor with your idea and ask if they would be willing to supervise you.
- You can also approach a prospective advisor if they would be willing to supervise you and then discuss a potential topic. - 1st year summer semester: Having agreed with you supervisor, enroll to the first of the three master's thesis courses in the Study Information System (SIS). Most of the communication with your supervisor is conveyed via email, with preferably regular, but sometimes occasional meetings in person (replace person by zoom in covid times). In this semester, you will likely get acquainted with the topic: You will be assigned some scientific papers to read, probably learn new technologies, get access to computation grid, etc. At the end of this semester, your supervisor will grant you credit for the first master's thesis course.
- 2nd year winter semester: Again, don't forget to enroll for the second of the master's thesis courses. In this semester, some serious coding usually happens. If you haven't started in the previous semester, you will probably design experiments, guided by your supervisor. You will implement code for these experiments, run it on the computational grid. If your thesis is more practical one, you may implement an application. This semester is very busy and if your topic was chosen well, it is usually (at least mildly) fun :) At the end of semester, you will be granted credit for the course.
- 2nd year summer semester: Finishing the experiments, polishing your application. But mostly, the writing. I will say more about the actual writing later in the following sections. Again, hopefully, you will be credited and will pass the third and last of the master's thesis courses at the end of this semester.
- End of study: Prior to being ML: allowed to submit your thesis and admitted to final exams, one has to have successfully cleared any other pending duties of the master's study, such as passed the mandatory exams and collected credits in sufficient amount, according to the specifications of your study programme. In other words, you have to finish all your courses and get necessary credits before you are allowed to submit your diploma thesis and/or registered for the state exam.
- State Final Exam: The master's programme is finished by taking a final exam, which consists of two parts, ML: a defense of the diploma thesis and an oral state final examinations – they can be taken jointly or separately in three possible terms throughout the year: summer (June), autumn (September) and winter (February), more detailed information below (a odkaz).
- Master's study defense (
obhajoba
in Czech): requires submitting the electronic (PDF) and the paper (hardcover) version of the thesis in the appointed deadline, enrolling for the exam in the Study Information System (SIS) (again, the in the official deadline) and obviously, showing up for the defence. More about the actual thesis defense later.
- Master's state final examinations (státnice
in Czech): requires registering for the examination in the required deadline and showing up for the examination. Also more on the examination later.
So each of both parts is offered separately in the Study Information System (SIS), each of them must be enrolled in the required deadline and they can be taken jointly or separately in three possible terms throughout the year:
summer
(June), autumn
(September) and winter
(February). Please note that the deadline for registration differs for each of the terms. There is a preferred way, when everything went well, and that is the summer final examination after the 2nd year's summer semester, taking both the defense and examination, which places the registration for both examinations and the submission of the thesis somewhere to May.
For LCT students: You will also have to come in person and defend the thesis plus pass the state exams at Charles University, even if you are at a partner university for the second year (unless discussed and arranged in a different way well in advance).
Survivor Advice:
“One thing I would like to do better next time (and advise students to do better in their first time) is time management: The programming part should be finished in a half time assigned to bachelor's thesis (even in case it is the main part of the master's thesis). In the end, it will delay and there will be a lot to correct and improve. The experimenting, evaluation, text writing and corrections (corrections!!!) will take more time than one expects. And even if it is not the case - then it's great, at least one is not stressed out from submitting at the last time and will have some spare time.”
'
Selecting the Topic, Finding the Supervisor and Registering the Topic in SIS
There are ML: two several ways to select your thesis topic:
- You can go to the module Thesis (Selection of subject) in the Study Information System (SIS) which lists an offer of yet unsubscribed theses. If any of them catches your eye, contact the supervisor by e-mail.
- ML: You can also check the UFAL webpage listing possible topics for a bachelor or master thesis or UFAL webpage in general.
- If you have a cool topic in mind, you can also approach a prospective supervisor with your idea and ask if they would be willing to supervise you.
- You can also approach a prospective advisor if they would be willing to supervise you and then discuss a potential topic.
- ML: You can simply send an email to the email conference thesis@ufal.mff.cuni.cz with a short list of (broad) areas you are interested in.
Your supervisor will be typically one of ÚFAL professors, researchers and Ph.D. students, although the supervisor may in theory come from other departments of Charles University (or even from other institution).
The student and their supervisor put together the title of the thesis and the description of the work (abstract): this will constitute the official assignment. It should be broad enough to allow deviations once the student gets their first results and realizes that the originally anticipated course of experiments is not the best one to follow. Later changes of title and topic are in theory possible but it is an administrative hassle that is better to avoid.
Necessary steps:
- The supervisor puts the assignment into SIS (the information system),
- the student registers for the topic via SIS,
- the supervisor approves their name and
- the supervisor also prints three hardcopies and pass them to Ms. Brdičková, the ÚFAL secretary.
The student office will later send back the hardcopy stamped and signed by the vicedean. Ms. Brdičková will keep it until the end of the academic year. The student will then have to pick it up and include it in one of the printed copies of the thesis (mandatory part, this copy goes to the faculty library).
Assignment of the thesis via SIS is described here: https://www.mff.cuni.cz/en/students/bachelor-and-master-thesis/guidelines-for-writing-a-master-thesis
Writing the Thesis
From the faculty guidelines:
The aim of the master thesis is to demonstrate an ability to work independently. The form a bachelor thesis takes may vary (background research, software, proof of a new theorem, etc.), due to the differences between various study programmes and disciplines. Presentation of original results is always desirable, but not necessary.
How Much Is Enough
The very fist question I usually get is “How much do I have to write?”
. As far as I know, there is no official number anywehere, so I'm just going to speak from experience: An experimental NLP master's thesis most probably non-rejectable on the basis of “too few text”
if it consists of absolute minimum of 40-50 A4 pages of content, not including the front page, acknowledgements, table of contents, bibliography & appendices. That is, the Conclusion Section should appear on page 40-50.
Me or We
Most scientific contributions were achieved in a team and it is therefore customary to write publications in plural, as in “We present”
, “We implemented”
and “We conclude that…”
. If you are a single author of the work, though, opinions differ on the choice of singular (“I”
) and plural (“We”
). Some even say a third person should be used as in “The researcher found out that…”
It is generally advisable to avoid the singular/plural choice wherever you can by using impersonal passive voice, such as “The research shows that…”
, “The findings suggest that…”
. The active voice singular (“I”
) would then be kept for sentences in which you underscore your particular contribution: “I implemented”
, “I measured”
. Even the use of “We”
throughout the thesis in all places where you are clearly referring to you as a single author, is acceptable. Using a plural “we”
instead of singular “I”
in scientific writings is supposedly called ''pluralis auctoris'' and Wikipedia says it is more common towards the East (hence the Wiki page is only in a few languages, including Czech, but excluding English). That being said, the choice is really yours.
The Content
An typical experimental NLP thesis usually consists of these parts:
- Oficially required formalities such as front page, declaration of independent work, dedication, abstract, etc.
- Introduction
- Theoretical Background/Related Work
- Methodology
- Results
- Discussion (sometimes merged with Results)
- Conclusions
- Bibliography
- Attachments
I describe each section in detail on a separate page.
Typesetting and Formatting
This is an area which you can get right and get some plus points for very low cost. Correct typesetting and formatting can be sitted through with a little of diligence and patience even if one is no Einstein. You won't get complaints for your thesis not being rocket science, but you can get a lot of complaints for poor presentation of your work. All of this can be avoided, if you:
- Read the official Guidelines for Writing a Master Thesis.
- Download the official LaTeX template and take this as an opportunity to learn LaTeX (or brush up your LaTeX skills). Please please be it LaTeX and not a WYSIWYG editor (Word, Libreoffice, …). It's just so easy to get beautifully typesetted text and mathematical formulas with LaTeX and so easy to ruin things otherwise. Also, get BibTeX for managing your references. You'll find yourself having to resist less urge to through it all away when you have to reindex your references in Word for the 50th time. Your future self will thank your current self if you put just a little work into setting up your thesis in LaTeX.
- Read my advice on typesetting, with good practices and frequent errors.
- Here you can find the formal faculty requirements of the thesis https://www.mff.cuni.cz/en/internal-affairs/regulations/dean-s-directive-no-1-2015
(Petricek, 2016)1)
For LCT students: You should follow the instructions for the thesis formatting as strictly as possible; however, some slight deviations commonly occur for LCT students and are tolerated. You can have your other university's name and logo on the title page. If you have co-supervisor from the other university, you can include their name as well. For the purpose of defense at Charles University, you should show your CUNI supervisor (i.e. the one that is indicated at your CUNI official assignment) as the main one. Name your CUNI supervisor on the abstract page.
Referencing, Plagiarism and These Things (Don't Skip Me!)
Plagiarism is a big NO-NO in science. It's so big you can get in serious trouble if caught. The trouble is, many people are not quite sure what plagiarism is and what it isn't. Sometimes, there is a grey area, but sometimes, the borderline is pretty clear.
Generally, plagiarism is presenting someone else's work/idea/text/source code as your own. Specifically, anything that appears in your thesis and is not referenced or is not general knowledge, is being presented by you as your work/idea/text/source code, unless properly referenced. Some very obvious examples of things that should be referenced are:
- big inventions with names: People who invented them should get credit. The first time you mention anything with a name, you should consider adding a reference. E.g., HMM, NNs, RNNs, LSTM, word embeddings (word2vec, FastText), contextualized word embeddings (BERT, …), etc.
- general ideas without names: The first attempts at solving some problem in a way which is similar to yours, or not similar, but was simply the first.
- copied material: Any time you copy anything more than a sentence, it should be referenced. Also definitions, adopted figures and tables.
- related publications: publications closely related to your work. Many master theses are incremental changes to one influential publication - which, obviously, must be referenced.
- source code: Give credit to those who implemented source code you use or build on. It is not necessary to reference Python, but one should reference specialized software (like TensorFlow) and especially the source code you modified. Most source code authors give exact instructions in README about how they wish to be referenced. Usually, by citing a publication.
- data: It is highly unlikely you did not need any data for your thesis. If you did, the data must be referenced. Most datasets are described in an accompanying publication. Some (older ones) are not, then at least give the url in footnote.
Every time you copy/reproduce a sentence/definition/figure/table, the reference must be repeated. It is not OK to state in the beginning of the section “And from now on, I shall draw from publication XY” and then go on three pages freely mixing your text and sentences from XY. With some exceptions, it is also not OK to copy entire paragraphs or pages, even if they are properly referenced, as you are supposed to write you own thesis, not copy someone else's work. It is however allright if you introduce/explain an idea with a proper reference and then discuss the idea in the next three paragraphs without referencing it again and again. If your discussion, however, replicates someone else's opinion, you should reference it, e.g. “Our data support hypothesis ABC, as well as results of REF-to-XY.”
Less obvious and not always necessary references may be required by:
- statements like
“It is (generally) considered that …”
,“It is (generally) thought that …”
are tricky. By whom it is considered? Ideally they would be supported by references to publications.
In scientific writing, there is a rigid, accustomed way of proper referencing. TODO write about reference norms.
Useful links
CUNI student handbook:
(pdf cz) https://karolinum.cz/knihy/foltynek-jak-se-vyhnout-plagiatorstvi-24022
(web cz) https://www.akademickaetika.cz/prirucka-pro-studenty/
(pdf eng) https://karolinum.cz/knihy/foltynek-how-to-avoid-plagiarism-24023
(web eng) https://www.akademickaetika.cz/en/student-handbook/
CUNI handbook for academic staff:
(pdf cz) https://karolinum.cz/knihy/foltynek-jak-predchazet-plagiatorstvi-ve-studentskych-pracich-24082
(web cz) https://www.akademickaetika.cz/prirucka-pro-akademicke-pracovniky/
(pdf eng) https://karolinum.cz/knihy/foltynek-how-to-prevent-plagiarism-in-student-work-24024
(web eng) https://www.akademickaetika.cz/en/handbook-for-academic-staff/
Noodle kurz na FF
https://www.ff.cuni.cz/2021/02/e-learning-focused-academic-integrity-research-ethics-english/
(asi zatím dostupné jen pro studenty FF, pracuje se na verzi pro celou uni)
odkazy na cizí uni:
https://gpsdocs.rice.edu/orientation/Plagiarism_Hewitt_document.pdf
http://cnx.org/content/col10604/1.1/
Abstract
píše se nakonec )
Jak s překladem do češtiny - typicky lze požádat o pomoc supervisora
It is strongly recommended that the abstract in your thesis differs from the abstract in the official assignment. Even though in theory you could claim that you did exactly what was in the assignment, it is better to show the reviewer that it is not just a copy. Typically, the assignment is more vague because you do not know what exactly you will do after you see the results of the first experiments. In contrast, the abstract should summarize what you actually did. Even if your thesis closely matches the assignment, the abstract probably should highlight your main achievement(s) (e.g. “we were able to improve the state of the art by 50%”).
Submitting the Thesis
Getting ECTS credits for the thesis
When you plan your classes for the academic year (and register them in SIS), you should also register for the three pseudo-courses reflecting your work on the thesis:
- NSZZ023 Diploma Thesis I,
- NSZZ024 Diploma Thesis II and
- NSZZ025 Diploma Thesis III.
At the end of the summer semester you will (hopefully) get the credits (in SIS) from your supervisor. This is not directly connected with the fact that the thesis will be (can be) defended. The credits just reflect the fact that you have invested significant time and effort into doing the research and preparing the thesis / meeting the agreed milestones.
In practice, the supervisor will not be able to award the credits if SIS does not know that you want them, i.e. if you have not registered for these pseudo-courses! While the registration can be completed just before the submission of the thesis, it may complicate the situation because the assistance of the student office is needed, the staff may be out of office (vacation time!), you may be traveling from the other end of Europe, trying to find all the people and get all the signatures within one afternoon etc.
Submitting
Note that you have to finish all your courses and get necessary credits before you are allowed to submit your diploma thesis and/or registered for the state exam.
The deadline for submission of a master thesis is specified in the Academic calendar https://www.mff.cuni.cz/en/students/academic-calendar ;
three possible terms are offered throughout the year: summer
(mid May), autumn
(mid July) and winter
(beginning of January).
You are suppose to submit your thesis in the following formats:
- An electronic version of the thesis should be submitted to SIS in due time.
- Two hardcopies are submitted as well
Electronic version
Don't fall in the PDF/A
trap! The electronic system requires all submitted PDF in PDF/A format and there is an automatic check for PDF/A. Allow yourself enough time to find out how to convert your PDF into PDF/A (like, not in the last two hours before deadline midnight). Some good advice on PDF/A, unfortunately only in Czech, can be found here.
The electronic file should not exceed 850 MB in size.
Dan píše ve svých poznámkách:
PDF-A requirements:
there is an ufal-wide installation of the verapdf tool available at /lnet/ms/projects/verapdf, with a useful wrapper script /lnet/ms/projects/verapdf/checkpdf that can be more talkative if you use the `–verbose` option.
Hardcopies
The hardcopies typically also contain a CD/DVD with the electronic version of the text (PDF) and all data and software that you created during the work, including documentation and possibly third-party software, if it is relevant and redistributable.
TODO: is this still true in 2021? The standard way is a zip attachment in SIS (plus a link to GitHub/Lindat/etc.).
If you order the binding in Prague, the stores typically know how the product should look like, so they will only ask you your name and the name of the faculty. You will have to submit two hardcopies of the thesis: one for the supervisor / the opponent and one for the library. The hardcopy for the library must also contain the original assignment, signed and stamped from the dean's office (at this time it is probably being kept for you by Ms. Brdičková – see above).
Final Examination
As has already been said, the final examination consists of two parts:
- Master's study defence (
obhajoba
in Czech): requires submitting the electronic (PDF) and the paper (hardcover) version of the thesis in the appointed deadline, enrolling for the exam in the study information system (SIS) (again, the in the official deadline) and obviously, showing up for the defence. More about the actual thesis defence later. - Master's state final examinations (
státnice
in Czech): requires registering for the examination in the required deadline and showing up for the examination. Also more on the examination later.
So each of both parts is offered separately in the study information system (SIS), each of them must be enrolled in the required deadline and they can be taken jointly or separately in three possible terms throughout the year: summer
(June), autumn
(September) and winter
(February). Please note that the deadline for registration differs for each of the terms. Actually, there is a preferred way, when everything went well, and that is the summer final examination after the 2nd year's summer semester, taking both the defence and examination, placing the registration for both examinations and the submission of the thesis somewhere to May.
In fact, the defence and the final state examination are usually organized in two different days with span about a week. One day accommodates all defences, the other on all final state examinations. The reason for this is purely organizational: different committees have to meet for each event.
Thesis Defence
Prepare a presentation (PDF, Microsoft PowerPoint or LibreOffice Impress). A laptop will be available (or you can use your own), with a dataprojector.
You will have only 10 minutes, which is very short time! The committee will be NLP-literate, but not necessarily specialized in your problem. Keep the introduction very short: the area I selected is XXX, the concrete problem is YYY, it is a problem because ZZZ (impact, motivation). Then another slide introducing methodology, then possibly a few interesting details from your research, then results. As with every presentation, avoid slides with too much text or too many numbers (or if you believe you need many numbers to be able to answer questions, highlight the one or two numbers that the audience should not miss). Avoid complicated formulas or anything that may take some time for the audience to grasp (remember, you will not give them much time because you will not have it). Avoid too many slides (1 minute per slide should be minimum).
Present the slides to yourself aloud, possibly several times. Try to arrange a dry-run with your supervisor. Get confident about what you are going to say. Check the timing.
There will be two written reviews of your thesis: one by your supervisor, the other by an opponent. Both reviews shall be available to you at least one week before the defense. The reviews may contain questions that you will have to answer during the defense. If so, prepare the answers. You may prepare slides to back the answers if applicable. In that case, don't include these slides in your main presentation. They don't count towards your time limit. Wait until asked, then show them (they may be part of the same presentation file, e.g. you may put them after the Thank You slide).