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 how OpenCL runtime manages buffers #81

Merged
merged 1 commit into from
Mar 16, 2022

Conversation

sherry-yuan
Copy link
Contributor

@sherry-yuan sherry-yuan commented Feb 15, 2022

It specifically documents;

  1. how it is used
  2. how sycl use it
  3. some caveats
  4. how memory are allocated
  5. device address encoding
  6. the whole implementation flow of all function that are responsible for allocation, memory transfer
  7. some corner cases

Closes #78

@sherry-yuan sherry-yuan marked this pull request as ready for review February 15, 2022 17:21
@aditikum aditikum self-requested a review February 22, 2022 19:49
@sherry-yuan sherry-yuan self-assigned this Mar 1, 2022
@sherry-yuan sherry-yuan added the documentation Improvements or additions to documentation label Mar 1, 2022
@sherry-yuan sherry-yuan added this to the 2022.3 milestone Mar 1, 2022
aditikum
aditikum previously approved these changes Mar 14, 2022
Copy link

@aditikum aditikum left a comment

Choose a reason for hiding this comment

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

Thanks for creating this documentation!

@sherry-yuan
Copy link
Contributor Author

@aditikum - Thanks for the approval! The approval are dismissed after new commits, you may need to re-approve.

@vijethamalkai @pcolberg @zibaiwan @huangbri - Does this seem ok to you?

zibaiwan
zibaiwan previously approved these changes Mar 14, 2022
Copy link
Contributor

@zibaiwan zibaiwan left a comment

Choose a reason for hiding this comment

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

@sherry-yuan , sorry for the late appoval. Your documentation looks great to me. Thanks for adding this. It's very helpful for runtime development.

@sherry-yuan
Copy link
Contributor Author

Thanks @vijethamalkai for the revision and suggestions! The latest commit 0879ed8 address Vij's suggestion on the use of ambiguous 'it' 'this' 'that' etc.

Copy link
Contributor

@pcolberg pcolberg left a comment

Choose a reason for hiding this comment

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

Thanks @sherry-yuan for the great work, and thanks @vijethamalkai for the corrections 🙂

---------------------------------------------------------------------------

It specifically documents;
1. how it is used
2. how sycl use it
3. some caveats
4. how memory are allocated
5. device address encoding
6. the whole implementation flow of all function that are responsible for allocation, memory transfer
7. some corner cases
@pcolberg pcolberg merged commit 49a70bb into intel:main Mar 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document how buffer are managed
4 participants