https://github.com/jvalue/made-template
Template repository for the Methods of Advanced Data Engineering course at FAU
https://github.com/jvalue/made-template
Last synced: 5 months ago
JSON representation
Template repository for the Methods of Advanced Data Engineering course at FAU
- Host: GitHub
- URL: https://github.com/jvalue/made-template
- Owner: jvalue
- Created: 2023-04-05T11:21:49.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-27T16:51:41.000Z (about 2 years ago)
- Last Synced: 2024-03-28T11:38:25.621Z (about 2 years ago)
- Homepage: https://oss.cs.fau.de/teaching/specific/made/
- Size: 1.46 MB
- Stars: 6
- Watchers: 4
- Forks: 230
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Methods of Advanced Data Engineering Template Project
This template project provides some structure for your open data project in the MADE module at FAU.
This repository contains (a) a data science project that is developed by the student over the course of the semester, and (b) the exercises that are submitted over the course of the semester.
To get started, please follow these steps:
1. Create your own fork of this repository. Feel free to rename the repository right after creation, before you let the teaching instructors know your repository URL. **Do not rename the repository during the semester**.
## Project Work
Your data engineering project will run alongside lectures during the semester. We will ask you to regularly submit project work as milestones, so you can reasonably pace your work. All project work submissions **must** be placed in the `project` folder.
### Exporting a Jupyter Notebook
Jupyter Notebooks can be exported using `nbconvert` (`pip install nbconvert`). For example, to export the example notebook to HTML: `jupyter nbconvert --to html examples/final-report-example.ipynb --embed-images --output final-report.html`
## Exercises
During the semester you will need to complete exercises using [Jayvee](https://github.com/jvalue/jayvee). You **must** place your submission in the `exercises` folder in your repository and name them according to their number from one to five: `exercise.jv`.
In regular intervals, exercises will be given as homework to complete during the semester. Details and deadlines will be discussed in the lecture, also see the [course schedule](https://made.uni1.de/).
### Exercise Feedback
We provide automated exercise feedback using a GitHub action (that is defined in `.github/workflows/exercise-feedback.yml`).
To view your exercise feedback, navigate to Actions → Exercise Feedback in your repository.
The exercise feedback is executed whenever you make a change in files in the `exercise` folder and push your local changes to the repository on GitHub. To see the feedback, open the latest GitHub Action run, open the `exercise-feedback` job and `Exercise Feedback` step. You should see command line output that contains output like this:
```sh
Found exercises/exercise1.jv, executing model...
Found output file airports.sqlite, grading...
Grading Exercise 1
Overall points 17 of 17
---
By category:
Shape: 4 of 4
Types: 13 of 13
```