docs: Image Processing tutorial

[robmeth]

Closes #373

Summary of Changes

There is a notebook-based documentation page that describes the different image processing methods, including an example for each.

[github-actions]

🦙 MegaLinter status: ✅ SUCCESS

Descriptor	Linter	Files	Fixed	Errors	Elapsed time
✅ PYTHON	black	1	0	0	0.55s
✅ PYTHON	mypy	1		0	1.44s
✅ PYTHON	ruff	1	0	0	0.13s
✅ REPOSITORY	git_diff	yes		no	0.12s

See detailed report in MegaLinter reports
Set VALIDATE_ALL_CODEBASE: true in mega-linter.yml to validate all sources, not only the diff

MegaLinter is graciously provided by

[codecov]

Codecov Report

Merging #419 (58afeb2) into main (9954986) will not change coverage.
The diff coverage is 100.00%.

@@            Coverage Diff            @@
##              main      #419   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           49        49           
  Lines         2594      2594           
=========================================
  Hits          2594      2594           

Impacted Files	Coverage Δ
src/safeds/data/image/containers/_image.py	100.00% <100.00%> (ø)

[zzril]

When generating the documentation from this branch with poetry run mkdocs serve, I cannot find the tutorials on the (localhost) webpage.
When I click on Tutorials on the top navigation bar, it still only lists Data processing, Data visualization and Machine Learning.

Looks like we need to add a reference to the new tutorial somewhere. Where?

Edit: Alright, looks like the mkdocs.yml is the place to go.

[jxnior01]

Looks good. Just a few grammatical errors:
Change: All operations on a Image return a new Image to All operations on an Image return a new Image.

[zzril]

Looks good. Just a few grammatical errors: Change: All operations on a Image return a new Image to All operations on an Image return a new Image.

Fixed.

[zzril]

Note to myself: Need to add adjust_color_balance to the tutorial.
Edit: Done.

Edit2: Assigned myself to this PR in hope that GitHub finally understands I'm not a reviewer here...

Edit3: @jxnior01 You have resolved one conversation, but your other comment still shows as "changes requested".

[zzril]

When generating docs with poetry run mkdocs serve and testing in a browser, the Tutorials page takes ages to load now. (Even before selecting the Image Processing tab.)

@lars-reimann Any ideas?

Edit: Solved.

The requested changes have been adopted.

[lars-reimann]

When generating docs with poetry run mkdocs serve and testing in a browser, the Tutorials page takes ages to load now. (Even before selecting the Image Processing tab.)

@lars-reimann Any ideas?

Did the site fully compile already when you opened it in the browser (see command line)? For me the compilation takes 42 seconds but the site is responsive afterwards.

[zzril]

When generating docs with poetry run mkdocs serve and testing in a browser, the Tutorials page takes ages to load now. (Even before selecting the Image Processing tab.)
@lars-reimann Any ideas?

Did the site fully compile already when you open it in the browser (see command line)? For me the compilation takes 42 seconds but the site is responsive afterwards.

Looks like I didn't. Or maybe I accidentally changed something while I was loading the page, causing it to recompile.

Works fine when I wait until compilation is over.

[Marsmaennchen221]

[zzril]

As we already have some performance issues with the docs (#447), I'm wondering if adding a bunch of images will make things worse.

@lars-reimann Shall I merge now anyway, or do you prefer to first solve the performance issue?

[lars-reimann]

That page loads quickly enough for me, so let's merge it if it's done.

[lars-reimann]

🎉 This PR is included in version 0.15.0 🎉

The release is available on:

• v0.15.0
• GitHub release

Your semantic-release bot 📦🚀