Discussion on making more demos to showcase abilities of Julia and libraries for Images

[ashwanirathee]

Hey Guys,I am Ashwani Rathee,undergraduate cs student at UIET,Panjab University,India
Saw this on: https://julialang.org/jsoc/gsoc/images/
I have explored JuliaImages in past: https://github.com/ashwani-rathee/Learning-Julia/blob/master/ImageProcessing%20in%20Julia.ipynb
And would love to contribute through examples: @timholy and @zygmuntszpak guide me on this and give me some direction to work on:)

Wide-ranging demos
For new or occasional users, JuliaImages would benefit from a large collection of complete worked examples organized by topic. While the current documentation contains many "mini-demos," they are scattered; an organized page would help users quickly find what they need. We have set up a landing page, but many more demos are needed. Scikit-image is one potential model.

This "project" might also be split among multiple students who contribute demos as part of their work in a focused area of JuliaImages.

[johnnychen94]

Hi Ashwani, thanks for your interest in JuliaImages!

Currently, demos in JuliaImages are managed by DemoCards. Existing demos are spreaded in multiple packages: juliaimages.github.io as the main doc, ImageFiltering.jl/docs for image filtering operations. The demos are written using a mixed Documenter markdown syntax, Literate julia syntax and DemoCards file syntax. You don't need to master all the syntax in the first go, as there are now many examples available for you to copy and modify. #144 is a good example of a demo PR.

We don't have a specific wish list of what demos should be added. It can be potentially dangerous for us to give a list as we're now "advanced" developers; things that are trivial to us might not be so trivial to others. For this reason, you can start with something simple based on your own decision and understanding.

[ashwanirathee]

Hey @johnnychen94 ,for the demos..is there any kind of preference for mosaicview over the plots.jl for showing the images??

[johnnychen94]

mosaicview is a very convenient and lightweight tool to preview multiple images in one-line of code. This is an advantage when making demos. Plots.plot definitely works, but it is quite heavy a dependency so I'd try to avoid its usage.

If you look at the Project.toml, you'll notice that Plots is currently not included as the build dependency.

This is just a preference, if there's a use case that can only be covered by Plots.jl, then use it. For example, if you're going to show something like this, then use Plots:

[ashwanirathee]

Hey @johnnychen94 ,I was trying to put my demos in the juliaimages website code..I followed the instructions in guide on front page(https://github.com/JuliaImages/juliaimages.github.io). But errors
were there that i `found

(base) ashwani@user:~$ cd julia-related/
(base) ashwani@user:~/julia-related$ cd juliaimages.github.io/
(base) ashwani@user:~/julia-related/juliaimages.github.io$ julia --project=. -e 'using Pkg; Pkg.instantiate()'
(base) ashwani@user:~/julia-related/juliaimages.github.io$ julia --project=. docs/make.jl
[ Info: SetupDemoCardsDirectory: setting up examples directory.
[ Info: SetupBuildDirectory: setting up build directory.
[ Info: Doctest: running doctests.
┌ Error: doctest failure in src/tutorials/conversions_views.md:312-332
│ 

After this part follows a long list of errors and warning and ends with:

│ These are docstrings in the checked modules (configured with the modules keyword)
│ that are not included in @docs or @autodocs blocks.
└ @ Documenter.DocChecks ~/.julia/packages/Documenter/3Y8Kg/src/DocChecks.jl:69
[ Info: Populate: populating indices.
[ Info: RenderDocument: rendering document.
[ Info: HTMLWriter: rendering HTML pages.
┌ Warning: invalid local link: unresolved path in function_reference.md
│   link.text =
│    1-element Array{Any,1}:
│     "Equalization"
│   link.url = "@ref"
└ @ Documenter.Writers.HTMLWriter ~/.julia/packages/Documenter/3Y8Kg/src/Writers/HTMLWriter.jl:1794
┌ Warning: invalid local link: unresolved path in function_reference.md
│   link.text =
│    1-element Array{Any,1}:
│     "Maurer et al., 2003"
│   link.url = "DOI: 10.1109/TPAMI.2003.1177156"
└ @ Documenter.Writers.HTMLWriter ~/.julia/packages/Documenter/3Y8Kg/src/Writers/HTMLWriter.jl:1794
[ Info: Redirect URL: redirect docs-edit-link for demos in examples directory.
┌ Warning: Documenter could not auto-detect the building environment Skipping deployment.
└ @ Documenter ~/.julia/packages/Documenter/3Y8Kg/src/deployconfig.jl:75

And it's not being deployed for me to check,even when I haven't added anything to it yet..pls guide

[johnnychen94]

you could find the built documentation in docs/build/index.html, open it in chrome or whatever web browser.

[ashwanirathee]

so @johnnychen94 it will update automatically when I add the demos and run this code ,right??and the index.html worked fine as expected

[johnnychen94]

correct, after you succesfully see docs/build/index.html file, you can add your new demo files in docs/examples. DemoCards detects whatever the demos you added, preprocess, and then pass to Documenter.

[ashwanirathee]

@johnnychen94 I was a little confused by the build_histogram after I get the values,do I have to build the histogram myself from the output or am I missing anything?

[ashwanirathee]

Is there a space for demo on image binarization here??I will do it using the methods in Image Binarization Package

[johnnychen94]

ImageBinarization has an overly detailed explanation in the docstring. My personal idea is to set up a new demo page in ImageBinarzation's own documentation (not here), and move those explanations from docstrings to demos. In the future, we could gather all those cards into this repo with the help of JuliaDocs/DemoCards.jl#72

[ashwanirathee]

Is there need for demo for creating ImagePyramids?ImagePyramids are used to implement algorithms for denoising, texture discrimination, and scale-invariant detection like here

[johnnychen94]

Since you're adding a bunch of demos, I'd like to introduce you to preview_demos("demo_file.jl") or preview_demos("path/to/demos_dir") if you haven't try it. This saves a lot of building time when we iteratively modify the codes and see the output page.

See also: https://johnnychen94.github.io/DemoCards.jl/stable/preview/#Example-%E2%80%93-JuliaImages