dl-course 2026.10.11.4__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- dl_course-2026.10.11.4/.gitignore +118 -0
- dl_course-2026.10.11.4/LICENSE +21 -0
- dl_course-2026.10.11.4/PKG-INFO +57 -0
- dl_course-2026.10.11.4/README.md +46 -0
- dl_course-2026.10.11.4/jupyter-config/nbconfig/rise.d/dl-course.json +9 -0
- dl_course-2026.10.11.4/pyproject.toml +29 -0
- dl_course-2026.10.11.4/src/dl_course/__init__.py +5 -0
- dl_course-2026.10.11.4/src/dl_course/aiml.py +804 -0
- dl_course-2026.10.11.4/src/dl_course/deep_learning.py +951 -0
- dl_course-2026.10.11.4/src/dl_course/foundations.py +644 -0
- dl_course-2026.10.11.4/src/dl_course/shared.py +726 -0
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
# --- Python & Virtual Environments ---
|
|
2
|
+
__pycache__/
|
|
3
|
+
*.py[cod]
|
|
4
|
+
*$py.class
|
|
5
|
+
*.so
|
|
6
|
+
.Python
|
|
7
|
+
.venv/
|
|
8
|
+
env/
|
|
9
|
+
venv/
|
|
10
|
+
ENV/
|
|
11
|
+
env.bak/
|
|
12
|
+
venv.bak/
|
|
13
|
+
build/
|
|
14
|
+
develop-eggs/
|
|
15
|
+
dist/
|
|
16
|
+
downloads/
|
|
17
|
+
eggs/
|
|
18
|
+
.eggs/
|
|
19
|
+
lib/
|
|
20
|
+
lib64/
|
|
21
|
+
parts/
|
|
22
|
+
sdist/
|
|
23
|
+
var/
|
|
24
|
+
wheels/
|
|
25
|
+
*.egg-info/
|
|
26
|
+
.installed.cfg
|
|
27
|
+
*.egg
|
|
28
|
+
.pytest_cache/
|
|
29
|
+
.coverage
|
|
30
|
+
htmlcov/
|
|
31
|
+
|
|
32
|
+
# --- Environment Variables & Secrets ---
|
|
33
|
+
.env
|
|
34
|
+
.env.*
|
|
35
|
+
*.env
|
|
36
|
+
.netrc
|
|
37
|
+
*.key
|
|
38
|
+
*.pem
|
|
39
|
+
*.cert
|
|
40
|
+
*.crt
|
|
41
|
+
*.pfx
|
|
42
|
+
*.p12
|
|
43
|
+
|
|
44
|
+
# --- Jupyter Notebooks & Checkpoints ---
|
|
45
|
+
.ipynb_checkpoints/
|
|
46
|
+
**/.ipynb_checkpoints/
|
|
47
|
+
.jupyter/
|
|
48
|
+
|
|
49
|
+
# --- Experiment Tracking & Log Files ---
|
|
50
|
+
wandb/
|
|
51
|
+
**/wandb/
|
|
52
|
+
*.wandb
|
|
53
|
+
runs/
|
|
54
|
+
**/runs/
|
|
55
|
+
lightning_logs/
|
|
56
|
+
# --- HTML & Log Files ---
|
|
57
|
+
*.html
|
|
58
|
+
*.log
|
|
59
|
+
|
|
60
|
+
|
|
61
|
+
# --- OS Specific Files ---
|
|
62
|
+
# macOS
|
|
63
|
+
.DS_Store
|
|
64
|
+
.AppleDouble
|
|
65
|
+
.LSOverride
|
|
66
|
+
._*
|
|
67
|
+
.Spotlight-V100
|
|
68
|
+
.Trashes
|
|
69
|
+
# Windows
|
|
70
|
+
Thumbs.db
|
|
71
|
+
ehthumbs.db
|
|
72
|
+
Desktop.ini
|
|
73
|
+
$RECYCLE.BIN/
|
|
74
|
+
# Linux
|
|
75
|
+
*~
|
|
76
|
+
|
|
77
|
+
# --- IDEs Config ---
|
|
78
|
+
.agents/
|
|
79
|
+
.agent/
|
|
80
|
+
.claude/
|
|
81
|
+
AGENTS.md
|
|
82
|
+
/scripts/
|
|
83
|
+
/scratch/
|
|
84
|
+
*.ses
|
|
85
|
+
:memory:.ses
|
|
86
|
+
**/review.md
|
|
87
|
+
.vscode/
|
|
88
|
+
*.code-workspace
|
|
89
|
+
.idea/
|
|
90
|
+
*.sublime-project
|
|
91
|
+
*.sublime-workspace
|
|
92
|
+
.project
|
|
93
|
+
.pydevproject
|
|
94
|
+
.settings/
|
|
95
|
+
|
|
96
|
+
# --- Data Caches & Downloaded Datasets ---
|
|
97
|
+
nltk_data/
|
|
98
|
+
.cache/
|
|
99
|
+
literature/
|
|
100
|
+
shared/data/MNIST/
|
|
101
|
+
shared/data/cifar*
|
|
102
|
+
**/MNIST/
|
|
103
|
+
**/cifar*
|
|
104
|
+
**/data/
|
|
105
|
+
|
|
106
|
+
# --- Archives ---
|
|
107
|
+
archive/
|
|
108
|
+
**/archive/
|
|
109
|
+
|
|
110
|
+
# --- LaTeX build files (project deliverable templates) ---
|
|
111
|
+
ML-DL/deliverables/**/*.aux
|
|
112
|
+
ML-DL/deliverables/**/*.bbl
|
|
113
|
+
ML-DL/deliverables/**/*.blg
|
|
114
|
+
ML-DL/deliverables/**/*.out
|
|
115
|
+
ML-DL/deliverables/**/*.fls
|
|
116
|
+
ML-DL/deliverables/**/*.fdb_latexmk
|
|
117
|
+
ML-DL/deliverables/**/*.synctex.gz
|
|
118
|
+
ML-DL/deliverables/**/*.pdf
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Konstantin Schekotihin
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: dl-course
|
|
3
|
+
Version: 2026.10.11.4
|
|
4
|
+
Summary: Plotting and asset helpers for the AAU Machine Learning and Deep Learning course notebooks
|
|
5
|
+
Project-URL: Repository, https://github.com/konstantin-schekotihin/dl_course
|
|
6
|
+
Author: Konstantin Schekotihin
|
|
7
|
+
License-Expression: MIT
|
|
8
|
+
License-File: LICENSE
|
|
9
|
+
Requires-Python: >=3.10
|
|
10
|
+
Description-Content-Type: text/markdown
|
|
11
|
+
|
|
12
|
+
# dl-course
|
|
13
|
+
|
|
14
|
+
Helper code for the notebooks of the [AAU Machine Learning and Deep Learning course](https://github.com/konstantin-schekotihin/dl_course).
|
|
15
|
+
It covers plotting, slide styling and loading course datasets and images.
|
|
16
|
+
|
|
17
|
+
The package is not a general-purpose library. It only serves the course notebooks.
|
|
18
|
+
|
|
19
|
+
## Usage in Google Colab
|
|
20
|
+
|
|
21
|
+
The first cell of every notebook installs the package when it runs in Colab:
|
|
22
|
+
|
|
23
|
+
```python
|
|
24
|
+
import sys
|
|
25
|
+
if "google.colab" in sys.modules:
|
|
26
|
+
%pip install -q dl-course
|
|
27
|
+
from dl_course import deep_learning as hp
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
## Modules
|
|
31
|
+
|
|
32
|
+
| Module | Used by |
|
|
33
|
+
|---|---|
|
|
34
|
+
| `dl_course.shared` | common base: themes, dataset/image loading, shared plots |
|
|
35
|
+
| `dl_course.aiml` | AI-ML course |
|
|
36
|
+
| `dl_course.foundations` | ML-DL, part 1: mathematical foundations |
|
|
37
|
+
| `dl_course.deep_learning` | ML-DL, part 2: deep learning |
|
|
38
|
+
|
|
39
|
+
## Slideshow settings
|
|
40
|
+
|
|
41
|
+
The package also installs the course's RISE slideshow settings into the environment's Jupyter configuration (`etc/jupyter/nbconfig/rise.d/dl-course.json`):
|
|
42
|
+
- the AAU header
|
|
43
|
+
- the white theme
|
|
44
|
+
- scrolling
|
|
45
|
+
- slide numbers
|
|
46
|
+
- the chalkboard
|
|
47
|
+
|
|
48
|
+
Jupyter Notebook picks them up automatically, so the notebooks contain no slideshow configuration. Colab ignores the file.
|
|
49
|
+
|
|
50
|
+
## Development and releases
|
|
51
|
+
|
|
52
|
+
- **Local development:** in the course repository, `uv sync` installs this package in editable mode. Changes take effect after a kernel restart.
|
|
53
|
+
- **Releases:** every push to `master` that changes `packages/dl-course/` publishes a new version to PyPI. A GitHub Action (`.github/workflows/publish-dl-course.yml`) does this, using a date-based version number.
|
|
54
|
+
|
|
55
|
+
## License
|
|
56
|
+
|
|
57
|
+
MIT (see the `LICENSE` file in the package source).
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# dl-course
|
|
2
|
+
|
|
3
|
+
Helper code for the notebooks of the [AAU Machine Learning and Deep Learning course](https://github.com/konstantin-schekotihin/dl_course).
|
|
4
|
+
It covers plotting, slide styling and loading course datasets and images.
|
|
5
|
+
|
|
6
|
+
The package is not a general-purpose library. It only serves the course notebooks.
|
|
7
|
+
|
|
8
|
+
## Usage in Google Colab
|
|
9
|
+
|
|
10
|
+
The first cell of every notebook installs the package when it runs in Colab:
|
|
11
|
+
|
|
12
|
+
```python
|
|
13
|
+
import sys
|
|
14
|
+
if "google.colab" in sys.modules:
|
|
15
|
+
%pip install -q dl-course
|
|
16
|
+
from dl_course import deep_learning as hp
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Modules
|
|
20
|
+
|
|
21
|
+
| Module | Used by |
|
|
22
|
+
|---|---|
|
|
23
|
+
| `dl_course.shared` | common base: themes, dataset/image loading, shared plots |
|
|
24
|
+
| `dl_course.aiml` | AI-ML course |
|
|
25
|
+
| `dl_course.foundations` | ML-DL, part 1: mathematical foundations |
|
|
26
|
+
| `dl_course.deep_learning` | ML-DL, part 2: deep learning |
|
|
27
|
+
|
|
28
|
+
## Slideshow settings
|
|
29
|
+
|
|
30
|
+
The package also installs the course's RISE slideshow settings into the environment's Jupyter configuration (`etc/jupyter/nbconfig/rise.d/dl-course.json`):
|
|
31
|
+
- the AAU header
|
|
32
|
+
- the white theme
|
|
33
|
+
- scrolling
|
|
34
|
+
- slide numbers
|
|
35
|
+
- the chalkboard
|
|
36
|
+
|
|
37
|
+
Jupyter Notebook picks them up automatically, so the notebooks contain no slideshow configuration. Colab ignores the file.
|
|
38
|
+
|
|
39
|
+
## Development and releases
|
|
40
|
+
|
|
41
|
+
- **Local development:** in the course repository, `uv sync` installs this package in editable mode. Changes take effect after a kernel restart.
|
|
42
|
+
- **Releases:** every push to `master` that changes `packages/dl-course/` publishes a new version to PyPI. A GitHub Action (`.github/workflows/publish-dl-course.yml`) does this, using a date-based version number.
|
|
43
|
+
|
|
44
|
+
## License
|
|
45
|
+
|
|
46
|
+
MIT (see the `LICENSE` file in the package source).
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
[project]
|
|
2
|
+
name = "dl-course"
|
|
3
|
+
# Placeholder: the publish workflow sets a date-based version (YYYY.M.D.RUN) before each upload.
|
|
4
|
+
version = "2026.10.11.4"
|
|
5
|
+
description = "Plotting and asset helpers for the AAU Machine Learning and Deep Learning course notebooks"
|
|
6
|
+
readme = "README.md"
|
|
7
|
+
requires-python = ">=3.10"
|
|
8
|
+
license = "MIT"
|
|
9
|
+
license-files = ["LICENSE"]
|
|
10
|
+
authors = [{ name = "Konstantin Schekotihin" }]
|
|
11
|
+
# No dependencies on purpose: notebooks run in the course .venv or in Google Colab, which already
|
|
12
|
+
# provide numpy, pandas, matplotlib, seaborn, scipy, torch and scikit-learn. Declaring them would
|
|
13
|
+
# make `pip install` in Colab upgrade or reinstall these packages.
|
|
14
|
+
dependencies = []
|
|
15
|
+
|
|
16
|
+
[project.urls]
|
|
17
|
+
Repository = "https://github.com/konstantin-schekotihin/dl_course"
|
|
18
|
+
|
|
19
|
+
[build-system]
|
|
20
|
+
requires = ["hatchling"]
|
|
21
|
+
build-backend = "hatchling.build"
|
|
22
|
+
|
|
23
|
+
[tool.hatch.build.targets.wheel]
|
|
24
|
+
packages = ["src/dl_course"]
|
|
25
|
+
|
|
26
|
+
# RISE slideshow settings for all course notebooks. Installed into <env>/etc/jupyter/nbconfig/rise.d/,
|
|
27
|
+
# which Jupyter Notebook reads automatically (notebook metadata would still override these).
|
|
28
|
+
[tool.hatch.build.targets.wheel.shared-data]
|
|
29
|
+
"jupyter-config/nbconfig/rise.d/dl-course.json" = "etc/jupyter/nbconfig/rise.d/dl-course.json"
|