Skip to content

Commit f3d7db8

Browse files
authored
Updates on assignments and presentations (#162)
* rm issue template * update assignments guide * update presentation guide * add emphasis
1 parent 6189f94 commit f3d7db8

File tree

3 files changed

+23
-29
lines changed

3 files changed

+23
-29
lines changed

.github/ISSUE_TEMPLATE/assignment-submission.md

Lines changed: 0 additions & 24 deletions
This file was deleted.

docs/assignments.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,11 +70,13 @@ To submit an assignment, you will need to provide screenshots of a successful te
7070

7171
![Example of a successful test run](./img/assignment-test-run.png)
7272

73-
You can submit the screenshots via GitHub issue using the issue template for [Assignment Submission](https://github.com/pkeilbach/htwg-practical-nlp/issues/new/choose).
73+
Please submit your screenshots via [email](mailto:pascal.keilbach@htwg-konstanz.de) to me.
7474

75-
!!! note
75+
When you submit your assignments, please provide a short description of your major learnings or challenges for each assignment.
76+
77+
!!! info
7678

77-
Submission via GitHub issue is preferred, but it is also accpeted if submit the screenshots via [email](mailto:[email protected]).
79+
Depending on your preference, you can submit all assignments at once, or submit them separately.
7880

7981
## Working on your Assignments
8082

@@ -141,3 +143,19 @@ As described in the [getting started](./getting_started.md) guide, there will be
141143
It can happen that these updates affect the assignments - just in case you are wondering why your tests suddenly fail 😅).
142144

143145
So make sure to always [fetch the latest updates](./getting_started.md#fetching-updates) before working on your assignments.
146+
147+
## Bonus Points
148+
149+
The assignment code is organized as a **fully functional Python package** which you can **push** to a package index and **install** it via `pip`.
150+
151+
If you manage to push your code to [Test PyPI](https://test.pypi.org/), you will earn 2 bonus points for the exam! 🤑
152+
153+
Find more details on how to package and publish your code [here](https://packaging.python.org/en/latest/tutorials/packaging-projects/#a-simple-project).
154+
155+
!!! info "Acceptance Criteria"
156+
157+
As soon as I can install your package with the following command, you are eligible for the bonus points:
158+
159+
```sh
160+
pip install --index-url https://test.pypi.org/simple/ --no-deps htwgnlp_YOUR_GITHUB_USERNAME
161+
```

docs/presentations.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ We will discuss the topic assignments in one of the first lectures.
2727

2828
## Scope
2929

30-
The scope of the presentation should be around **15-20 minutes** and you should include a **demo or practical example**.
30+
The scope of the presentation should be around **15-20 minutes**. Ideally, you should include a **demo or practical example** (but I am aware that probably not all topics are equally suitable for that).
3131

32-
For the **demo**, try to aim for 30-50% of the time (depending on the topic). Feel free to use any tool you want. You can show something in the browser, use Postman or Jupyter notebooks, or do some live hacking on the command line. 🤓
32+
For the **practical part**, try to aim for 25-50% of the time (depending on the topic). Feel free to use any tool you want. You can show something in the browser, use Postman or Jupyter notebooks, or do some live hacking on the command line. 🤓
3333

3434
Besides that, there are no strict rules about the presentation format. You can use slides if you want, but it is not mandatory.
3535

0 commit comments

Comments
 (0)