slds-lmu/lecture_dl4nlp

Repo containing all the lecture material for the dl4nlp course

How to set this up?

1. git clone https://github.com/slds-lmu/lecture_dl4nlp.git
2. cd lecture_dl4nlp
3. git clone https://github.com/slds-lmu/latex-math.git

How to get started with your new lecture repository?

1. The very basic structure of the template contains
   1. slides: Raw .tex files of your lecture and the corresponding PDFs.
   2. exercises: Raw .tex exercise files and the corresponding PDFs or .ipynb files.
   3. code-demos: Raw .py files for code demos (optionally, not yet there).
   4. cheatsheets: Material for cheatsheets optionally, not yet there).
   5. latex-math: Submodule included from github.com/slds-lmu/latex-math (see point 3 from setup).
   6. style: All relevant style files.
2. Each folder contains a README.md with more details.

General editing workflow

1. The main branch should only contain the material that is visible on the website.
2. Work is exclusively done in subbranch of the main branch!
3. When you have finished a task, write a short understandable commit message, the smaller and more precise your commit is the better.
4. Create a PR to the main branch and describe what you have done, reference issues, etc. Also assign a reviewer if necessary.
5. The responsible person for the lecture then merges the PRs.

Contents, License, Team and Further Info

Please see the main course site.

Help is appreciated and welcome!

We hope to continously improve and expand this course over the coming years. We strongly believe in open source and collaborative work. Please contact us if you think likewise and would like to contribute. See also our contributing guidelines

• Are you an NLP/ML expert and like the course, but have some feedback or consider extending it? Write an email to Matthias (see Team page) or Open an issue.
• Are you a student taking the lecture - either at the LMU or online - and you spotted a typo, think we should rephrase something be or even would like to provide a new quiz question or coding example? Please consider providing a pull request. To do so, please check out the main branch of the repo and add your fixes there. Writing an e-mail or opening an issue with suggested improvements is obviously very welcome as well!
• You are none of the above but would like to contribute, get in touch / open issues / create pull requests! We are happy about any help.

License

This work is licensed under a Creative Commons Attribution 4.0 International License.

We would appreciate if you contact us in case you are re-using our course. Knowing this helps us to keep the project alive. Thank you!