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

[Doc] Update KernelProgramCache.md with details on in-memory eviction #16129

Merged
merged 5 commits into from
Nov 25, 2024

Conversation

uditagarwal97
Copy link
Contributor

This PR updates KernelProgramCache.md by:

  1. Making the doc in-sync with recent changes in in-memory cache (Like [SYCL] Remove CompileOpts and LinkOpts from Cachekey #11351)
  2. Adding details of in-memory cache eviction ([SYCL] Implement eviction for in-memory program cache #16062)

Partially fixes: #16017

@uditagarwal97 uditagarwal97 self-assigned this Nov 20, 2024
@uditagarwal97 uditagarwal97 requested a review from a team as a code owner November 20, 2024 06:02
Copy link
Contributor

@maarquitos14 maarquitos14 left a comment

Choose a reason for hiding this comment

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

UR is added in this new changes, but there are still plenty of mentions to PI throughout the document. Can we get them updated? PI does no longer exist.

Also, I like this kind of documents to be self-contained, so I don't like us pointing readers to EnvironmentVariables.md in Cache Configuration section. That's just a matter of style, so I will not block approval based on this, but I would like to have the environment variables listed in this document to make it easier for readers.

@maarquitos14
Copy link
Contributor

@steffenlarsen since you reviewed #16062 too, you might want to take a look at this as well.

Copy link
Contributor

@steffenlarsen steffenlarsen left a comment

Choose a reason for hiding this comment

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

A couple of comments, mostly editorial and for consistency.

sycl/doc/design/KernelProgramCache.md Outdated Show resolved Hide resolved
sycl/doc/design/KernelProgramCache.md Outdated Show resolved Hide resolved
sycl/doc/design/KernelProgramCache.md Outdated Show resolved Hide resolved
sycl/doc/design/KernelProgramCache.md Outdated Show resolved Hide resolved
sycl/doc/design/KernelProgramCache.md Outdated Show resolved Hide resolved
sycl/doc/design/KernelProgramCache.md Outdated Show resolved Hide resolved
@uditagarwal97
Copy link
Contributor Author

UR is added in this new changes, but there are still plenty of mentions to PI throughout the document. Can we get them updated? PI does no longer exist.

Also, I like this kind of documents to be self-contained, so I don't like us pointing readers to EnvironmentVariables.md in Cache Configuration section. That's just a matter of style, so I will not block approval based on this, but I would like to have the environment variables listed in this document to make it easier for readers.

In e24d975, I've removed remaining PI references and added cache-related environment variables in this doc itself.

Copy link
Contributor

@steffenlarsen steffenlarsen left a comment

Choose a reason for hiding this comment

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

LGTM!

Copy link
Contributor

@maarquitos14 maarquitos14 left a comment

Choose a reason for hiding this comment

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

Just a nit, otherwise LGTM.

sycl/doc/design/KernelProgramCache.md Outdated Show resolved Hide resolved
@uditagarwal97
Copy link
Contributor Author

@intel/llvm-gatekeepers the PR is ready to be merged.

@sarnex sarnex merged commit e127a2e into intel:sycl Nov 25, 2024
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Docs] Make KernelProgramCache.md doc consistent with in-memory cache implementation
4 participants