Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

intro tutorial draft 1 #116

Merged
merged 9 commits into from
Jan 26, 2025
Merged

intro tutorial draft 1 #116

merged 9 commits into from
Jan 26, 2025

Conversation

hankunxiao
Copy link
Collaborator

No description provided.

@hankunxiao hankunxiao added this to the Milestone 3 milestone Jan 24, 2025
@hankunxiao hankunxiao self-assigned this Jan 24, 2025
@hankunxiao
Copy link
Collaborator Author

The hyperlinks to the each individual function's documentation need to updated once we push our docs to readthedocs.io.

@Arc-Celt
Copy link
Collaborator

Arc-Celt commented Jan 24, 2025

Great intro overall! All the examples and options to load and display images are sound and clear.
One thing I wanna ask about is that what does "Yalla" in the subtitle mean?
And consider adding more background info in the starters of the background story. Currently it seems a bit strange that after the subtitle "Sami's Story", you immediately start with "he...". You could rewrite the start to introduce Sami, for example:
"Sami is a cat meme enthusiast who is always on the lookout for the best cat memes. He also loves taking pictures of his own cats to create memes every day."

Copy link
Collaborator

@Arc-Celt Arc-Celt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, I suggest changing the Heading I title to something else, like "First Things First", because the html rendered will list the title on the sidebar under the existing "Tutorial", and it would seem a bit repetitive.

image

@hankunxiao
Copy link
Collaborator Author

Great intro overall! All the examples and options to load and display images are sound and clear. One thing I wanna ask about is that what does "Yalla" in the subtitle mean? And consider adding more background info in the starters of the background story. Currently it seems a bit strange that after the subtitle "Sami's Story", you immediately start with "he...". You could rewrite the start to introduce Sami, for example: "Sami is a cat meme enthusiast who is always on the lookout for the best cat memes. He also loves taking pictures of his own cats to create memes every day."

Yalla means "Let's get started". I will update it to "Let's get started" for more clarity.
That's good suggestion. i will update them

@hankunxiao
Copy link
Collaborator Author

@Arc-Celt thanks for your feedback. I have incorporate them in the latest commit. You can go to this feature branch and find the updates.

@Arc-Celt Arc-Celt self-requested a review January 24, 2025 05:21
Copy link
Collaborator

@Arc-Celt Arc-Celt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Everything looks great now! Should be ok to merge

@Arc-Celt Arc-Celt self-requested a review January 24, 2025 23:05
@hankunxiao
Copy link
Collaborator Author

@JennyonOort I have pushed the 2nd draft to this feature branch. Please adjust it as needed.
CC: @Arc-Celt

@JennyonOort JennyonOort reopened this Jan 26, 2025
@JennyonOort
Copy link
Collaborator

Intro draft rewritten for consistency and mutually exclusivity to other individual functions.

@JennyonOort
Copy link
Collaborator

Here is the revised structure of intro proposed. Removed web url reading option as per discussion it is usually not stable and downloading is preferred. In addition, a default [0, 255] range image reader is selected and thus conversion becomes optional and does not need demonstration.

image

@JennyonOort JennyonOort merged commit 9d288c8 into main Jan 26, 2025
3 of 6 checks passed
@JennyonOort JennyonOort self-assigned this Jan 26, 2025
@JennyonOort JennyonOort assigned hankunxiao and unassigned hankunxiao Jan 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

Introduction of the tutorial (loading, transforming and displaying image)
3 participants