ImperialCollegeLondon / ImperialCollegeLondon/ReCoDE-Segmentation-Lab

[Idea]: Notebook structure

Open
#39 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Jupyter Notebook
Stars
0
Forks
0
PR merge metrics
No merged PRs in 30d

Description

I was wondering if it's useful for learners to split up our main notebook into self contained parts for each of our image processing algorithms. Particularly if we want to go more in depth on any algorithm with visual examples this might be more digestible than one bigger file. For example we could have multiple notebooks (just copying what you have in the pipeline):
-synthetic_test_images.ipynb
-threseholding.ipynb
-distance_transform.ipynb
-local_minima_detection.ipynb
-watershed.ipynb
-analysing_segmented_objects.ipynb
-full_pipeline,ipynb

Then you can just set up your full_pipeline,ipynb for the user to run with a customisable example without explaining all the steps.

Would be good to hear your thoughts @davidbuech @jianlianggao

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the existing main notebook and the proposed structure: synthetic_test_images.ipynb, thre(se)holding.ipynb, distance_transform.ipynb, local_minima_detection.ipynb, watershed.ipynb, analysing_segmented_objects.ipynb, and full_pipeline.ipynb. Done means agreeing on the split and producing self-contained algorithm notebooks while keeping a customizable full-pipeline example.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter-notebook, python
Domain
documentation
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.