Skip to content

Latest commit

 

History

History
305 lines (222 loc) · 19 KB

README.md

File metadata and controls

305 lines (222 loc) · 19 KB

Python for text analysis

As taught at the Vrije Universiteit Amsterdam in the Humanities Research Master: Linguistics (track Human Language Technology) and the Minor Digital Humanities and Social Analytics (BA).

In case you have questions about exemption, please first read Python-test.md.

This is a practical course in Python, geared towards those who want to get some hands-on experience working with language data. No knowledge of programming is required or presupposed. We will work with Python 3.9 or higher. We highly recommend installing Anaconda for this course.

(If you have worked with Python 3 before, be sure to check if Jupyter Notebook is installed on your machine. We will work extensively with notebooks. Make sure you are working with Python 3.9.)

This course is based on the material used in previous years and in this course.

Goals

This course is meant to introduce you to the basics of the Python programming language. There is a lot to discover about Python and programming in general, and you will probably learn something new every day if you continue programming after this course. Our goal for you is to become an independent programmer who is able to find solutions to new problems.

You will

  • learn how to work with the standard library of Python
  • learn how to deal with different file types (e.g., plain text, CSV/TSV, JSON)
  • learn how to use some external libraries (e.g., to analyze texts)
  • learn how to document and share your code and results

We will focus on readability and understandability, so that you will be able to share your code and results with others, and re-use your code in the future. This is a practical course, in which you will get a lot of hands-on experience. Due to the nature of this course, active participation is required.

Since 2021-22, we have been offering a bachelor- and a master-level version of this course. For the bachelor version, we emphasize applications in Digital Humanities. For the Master-level, we emphasize a more thorough understanding of the fundamentals of python and independent problem-solving. These differences are reflected in the material of the second half of the course (Block III and IV).

Core principles

We strongly believe in a set of principles outlined by Mike Bostock in his article What makes software good?. We have designed our course around those principles and summarized them for you below:

  • Good software is approachable. It can be understood completely in independent, easy pieces. You don’t need to understand everything before you can understand anything.

  • Good software is consistent. It lets you take what you’ve learned about one part and extrapolate it to the rest. It doesn’t self-contradict. It is parsimonious, avoiding superfluous elements.

  • Good software explains itself. It has affordances for learning and discovery. It is role-expressive and minimizes hidden magic.

  • Good software teaches. It doesn’t just automate an existing task, but provides insight or imparts knowledge, such as a best practice or a new perspective on a problem.

  • Good software is for humans. It is cognizant of people and the reality in which they live. It does not expect elaborate and arbitrary rules to be memorized. It anticipates the need for learning and debugging.

What to do if you get stuck

Programming almost always involves running into problems and getting stuck. This is normal and even happens to very experienced programmers. We are trying to offer support to all students, but this means we have to prioritize and manage our time well. In order for this to work, please try to follow the following strategies when you get stuck:

  • Check the class material for solutions. The chapters treated in the assignment are usually a good start. As the course progresses, you may have to also check the material from earlier blocks.
  • If you get error messages, read them carefully - they are informative! In particular, check the line in which the error occurs and the line immediately preceding it. If you don't understand what it says, try to google it (you will most likely find some explanation on Stackoverflow).
  • Break down your task into small steps using pen and paper. Sometimes, you lose sight of the bigger picture when dealing with complicated code. Breaking down a big task into small tasks helps you identify the problem.
  • Explain the problem to someone else (e.g., a classmate). Go through the code line by line and explain what it does (See pair programming and rubber duck debugging).
  • Finally, take a break! Very often, just having a fresh look at the code helps!
  • If none of these steps helped, please try to ask for help well before the assignment deadline. Please start by posting your questions on Piazza. If you email the teachers or TAs, please always email your code rather than a screenshot.

Learning how to help yourself is a valuable skill and will be very useful in your future programming projects.

Courseware structure

Our materials are structured as follows:

  • The Chapters folder contains our primary teaching material. Every week, you will work through a subset of these interactive notebooks. We expect you to look at the material in preparation for the lectures. If you get stuck with an assignment, first see if you can find the solution in the Chapters.

  • The Assignments folder contains the assignments that you will be asked to submit during the course.

  • The Extra_Material folder contains some extra reading about the Python theory, which you may use for future reference. It also contains some information specifically related to natural language processing, and examples on how to organize your code and how to create a Flask website.

  • The Data folder contains all data used in this course and more, as well as the scripts used to obtain this data. (So you can see what techniques we used.)

This file serves as the syllabus and a general reference for this course.

Assignments and Grading

The course is worth 6 ECTS and will consist of 2 ungraded assignments, a midterm exam, 2 graded assignments and a final exam. There will be no submission for Assignments 1 and 2. Please check the submission schedule for details about the submission of Assignments 3 and 4. We have reserved some lectures to discuss the assignments in class and provide feedback. The assignments and the exams are weighted as follows.

Part weight %
Assignment 1 not graded
Assignment 2 not graded
Midterm Exam 20
Assignment 3 20
Assignment 4 20
Exam 40
Total 100

Course assignments

You are asked to hand in 2 assignments in total. The deadlines are indicated below. Submission 1 day after the deadline and before the feedback session downgrades your grade by 2 (e.g., a 9 will result in a 7). After that (i.e. on day 2 or after the feedback session has started), the resulting grade is a 1. We have to be strict about this because we will discuss the assignments in class, and we need time to look at your submissions. In addition, the solutions will be discussed in the feedback session, and we cannot award points after the solutions have been discussed.

Please note that a passing grade for each assignment (5.5) is required to pass the course. You will be allowed to fail one assignment, which will need to be made up by submitting a resit assignment (please read the limitations on resit opportunities outlined below).

Assignment submissions

Submission is made through Canvas. Please submit your assignments using the corresponding assignment submission on Canvas (e.g. labeled 'Assignment 3' for Assignment 3).

Please note that we cannot accept assignments submitted via email.

Resits for Assignments

You can retake a maximum of one out of the two graded assignments. Important note: if you fail or miss more than one assignment, you automatically fail the course.

Please note that the level of the resit assignment will be equivalent to the more advanced components of Assignment 4. The resit assignments will be published at the end of the course and there will be a deadline for submission (tba).

It is highly recommended to submit both assignments at the regular deadlines. Please only make use of the resit opportunity in case you failed an assignment or were dealing with exceptional circumstances (e.g. illness). Please note also that the deadline of the resit assignment will fall into period 2 and thus interfere with your new courses.

Midterm exam

The midterm exam will assess the basics of Python syntax and over the content covered in Block 1 and Block 2. As preparation for this exam, please work through the material of the blocks and complete Assignment 1 and 2. Passing the midterm exam ensures that you are ready for the more advanced component of the course. The format of the exam is pen on paper (no external tools allowed).

Final exam

The exam tests your knowledge of the syntax of Python, and your knowledge of the standard library. It serves as an opportunity to show what you've learned and will ensure that you have sufficient knowledge to tackle your own code projects and continue improving your python skills by yourself. You cannot pass the course without a passing grade on the exam. But don't worry: if you are able to finish the assignments, you will be fine on the exam. Please note that the format of the final exam is computer-based, but you will not have access to a python interface or the internet (just like in the midterm exam).

Resit exams

There will be an opportunity to take a resit for the exams. The exact dates will be announced.

It is highly recommended to aim for a passing grade at the regular exam dates. Please only make use of a resit exam if you fail a regular exam or were dealing with exceptional circumstances (e.g. exam date conflict, illness).

Planning

There are 4 Blocks with associated chapters and assignments:

Block Chapters BA Chapters MA Assignment BA Assignment MA
I Chapters 1-4 Chapters 1-4 Assignment 1 Assignment 1
II Chapters 5-11 Chapters 5-11 Assignment 2 Assignment 2
III Chapters 12-15 Chapters 12-15 Assignments 3a and 3b (Exercises 3 and 4 of Assignment 3b are excluded for BA students) Assignments 3a and 3b
IV Chapters 16, 17, 22 Chapters 16-18 Assignments 4a and 4b-BA Assignments 4a and 4b-MA

The content of the exam only covers the content of the chapters treated in the course. Chapters 19, 20, and 21 will not be tested in the Assignments (nor on the exam). They serve as additional resources.

The schedule for the entire course follows the same structure, illustrated below.

Block structure

Lecture 1

In the first lecture, we explain and practice the basics of the new block. It is highly recommended to go through the chapter notebooks in preparation for the classes. Feel free to watch the additional video material provided on Canvas to understand the basic notions. After the first lecture, you are expected to start working on the assignment and consult the chapters for things that are unclear to you.

Please be aware that the level of the assignments is a little bit higher than the level of the exercises provided at the end of each chapter. Solving the assignments requires taking some extra steps; you will have to combine notions from different chapters and most likely go through several cycles of trial and error. Therefore, please take into account that the assignments can most likely not be completed in a single day. Also, solving code problems is much easier if you have sufficient time for breaks.

Lecture 2

In the second lecture, we will further highlight some of the theory, and you will have time to practice more advanced notions. Support will be provided by the teachers and student assistants. It is highly recommended to prepare questions you have about the assignment and post them on Piazza (QA forum - access provided via our Canvas) before class. Ideally, we can prepare the lecture in such a way that it will help you finalize your assignment. You will finish the assignment between the second and third lecture and hand it in on either Wednesday or Friday.

Lecture 3

Finally, the third lecture is a feedback session where we will discuss some of the main problems that were encountered in the assignments. We will repeat this cycle multiple times (for each assignment). Please note that we will use a single feedback lecture for Blocks 1 and 2 (see course schedule below).

Course schedule

Block What When Description
1 lecture Tuesday 2024-09-03
13:30 - 15:15
Introduction theory
lecture Thursday 2024-09-05
15:30 - 17:15
Theory and work time
2 lecture Tuesday 2024-09-10
13:30 - 15:15
Introduction theory
lecture Thursday 2024-09-12
15:30 - 17:15
Theory and work time
EXAM Tuesday 2024-09-17
13:30 - 15:15
Midterm Exam (in class)
lecture Thursday 2024-09-19
15:30 - 17:15
Feedback Midterm/Assignments
3 lecture Tuesday 2024-09-24
13:30 - 15:15
Introduction theory
lecture Thursday 2024-09-26
15:30 - 17:15
Theory and work time
DEADLINE Monday 2024-09-30
before 17:00
SUBMIT ASSIGNMENT 3
lecture Tuesday 2024-10-01
13:30 - 15:15
Feedback assignment
4 lecture Thursday 2024-10-03
15:30 - 17:15
Introduction theory
MA lecture Tuesday 2024-10-08
13:30 - 15:15
Theory and work time
BA lecture Tuesday 2024-10-08
15:30 - 17:15
Theory and work time
MA lecture Thursday 2024-10-10
15:30 - 17:15
Theory and work time
BA lecture Thursday 2024-10-10
15:30 - 17:15
Theory and work time
DEADLINE 2024-10-14
before 17:00
SUBMIT ASSIGNMENT 4
Resit Tuesday 2024-10-15
13:30 - 15:15
Resit for Midterm Exam
BA/MA lecture Tuesday 2024-10-15
15:30 - 17:15
BA/MA Feedback assignment
Exam Preparation Lecture Thursday 2024-10-17
15:30 - 17:15
Exam preparation
EXAM Tuesday 2024-10-22
8:30-11:15 (11:45, extra time)
EXAM (important: check location)

Plagiarism

Cheating is serious; it is considered fraud and can lead to being excluded from your studies (https://vu.nl/en/student/your-faculty/examination-board). It is also harmful; not only for yourself (you can fool yourself and fail to learn this useful skill), but also for other students (if multiple students do better because of cheating, teachers may think a grading scheme is fair, even though it needs to be adjusted).

How to avoid plagiarism, while making use of online sources and collaborating with fellow students:

For the assignments, let us know in the comments if you have worked together with a class mate or if you used code from online sources, such as stackoverflow. If you found some useful code online, do try to understand what that piece of code does. If it looks 'complicated', we expect you to provide in-line comments in the code explaining what it does.

We highly discourage relying on ChatGPT (or similar tools) in this course. While code support can be useful later on, we know that it has a negative impact on the learning process early on. Students who rely too much on such tools fail to progress to more advanced coding assignments. If you use code generated by a model, please provide:

  • your prompt (what you provided as input)
  • the code generated by the model
  • your comments explaining what the code does and how you adapted it

If you use code you found online in an assignment, please indicate it in the following way:

### Taken from [link] [date]

[code]

\###

Please use a similar format to indicate that you have worked with a classmate (e.g. mention the name instead of the link). Make sure to provide your own comments to show that you understood and indicate what you did yourself, e.g. by commenting your partial solution out (we cannot give credits for copy-pasting full answers from classmates, but you may get full points for a partial individual solution and well commented working one with components from a classmate). If you work on a solution together, also indicate this and make sure to provide individual explanations.