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

add documentation for image layouts #1705

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

johnnychen94
Copy link
Contributor

@johnnychen94 johnnychen94 commented Aug 31, 2021

The contents are quite self-explained here, I'm most familiar with images so I try to explain everything I know about images, and hopefully, the same reasoning applies to other data types as well. I'm not Flux, CUDA, or performance expert, I'm not a native English speaker, please feel free to make suggestions on whether the contents or the word choices.

@johnnychen94 johnnychen94 marked this pull request as ready for review September 1, 2021 03:34
@johnnychen94 johnnychen94 changed the title WIP: add documentation for image layouts add documentation for image layouts Sep 1, 2021
Copy link
Member

@darsnack darsnack left a comment

Choose a reason for hiding this comment

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

Mostly left some minor comments, but this is amazing! Thanks for taking the time to write it up; I know it will benefit a lot of users.

docs/src/data/image_layouts.md Outdated Show resolved Hide resolved
docs/src/data/image_layouts.md Outdated Show resolved Hide resolved
docs/src/data/image_layouts.md Outdated Show resolved Hide resolved
docs/src/data/image_layouts.md Outdated Show resolved Hide resolved
docs/src/data/image_layouts.md Outdated Show resolved Hide resolved
docs/src/data/image_layouts.md Outdated Show resolved Hide resolved
docs/src/data/image_layouts.md Outdated Show resolved Hide resolved
docs/src/data/image_layouts.md Outdated Show resolved Hide resolved
docs/src/data/image_layouts.md Outdated Show resolved Hide resolved
docs/src/data/image_layouts.md Outdated Show resolved Hide resolved
@johnnychen94
Copy link
Contributor Author

johnnychen94 commented Sep 7, 2021

#1705 (comment)
I was thinking this would be a one-time manual step where one of us just runs through all the code in the table and makes note of the ones that error. Then we add a parenthetical for the ones that break AD.

I'm afraid that I don't have time to do this recently. I'll come back when I'm available and resolve any further comments together.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants