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

Unchecked kernel launch should precisely state the safety contract #217

Open
torsteingrindvik opened this issue Oct 30, 2024 · 0 comments
Open
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@torsteingrindvik
Copy link
Contributor

torsteingrindvik commented Oct 30, 2024

When hovering the launch_unchecked call, no safety docs appear:

image

docs.rs has a bit more: https://docs.rs/cubecl/latest/cubecl/prelude/struct.KernelLauncher.html#method.launch_unchecked

But that isn't in sync with the docs on the generate module from the kernel proc macro, which only has:

   #[doc = "Launch the kernel [gelu_array()] on the given runtime"]

which we see in the image.

@nathanielsimard nathanielsimard added documentation Improvements or additions to documentation good first issue Good for newcomers labels Nov 4, 2024
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 good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants