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 doc about kernels and functions #8400

Merged
merged 4 commits into from
Nov 3, 2023
Merged

Conversation

lin-hitonami
Copy link
Contributor

@lin-hitonami lin-hitonami commented Oct 31, 2023

Issue: #8387

Brief Summary

🤖 Generated by Copilot at aff59bb

This pull request updates the documentation of kernels and Taichi functions in docs/lang/articles/kernels/kernel_function.md. It introduces the concepts of Taichi real functions and multiple return values for kernels, and explains how they differ from other types of Taichi functions and kernels.

Walkthrough

🤖 Generated by Copilot at aff59bb

  • Introduce and document the new feature of Taichi real functions, which allow recursive calls and multiple return statements, using the @ti.real_func decorator (link, link)
  • Update the definition and terminology of Taichi functions to include both Taichi inline functions and Taichi real functions, and explain their differences (link, link)
  • Emphasize the requirement of type hinting the arguments of kernels, which is different from Taichi functions (link)
  • Document and demonstrate the new feature of kernels having multiple return values, using tuples as return types (link, link)

@netlify
Copy link

netlify bot commented Oct 31, 2023

Deploy Preview for docsite-preview ready!

Name Link
🔨 Latest commit 3109488
🔍 Latest deploy log https://app.netlify.com/sites/docsite-preview/deploys/654217f4474d0e00088b8cc2
😎 Deploy Preview https://deploy-preview-8400--docsite-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@lin-hitonami lin-hitonami marked this pull request as ready for review November 1, 2023 09:12
@lin-hitonami lin-hitonami added this to the v1.7.0 milestone Nov 2, 2023
@lin-hitonami lin-hitonami merged commit fc4c8f1 into master Nov 3, 2023
25 checks passed
@lin-hitonami lin-hitonami deleted the real-func-doc branch November 3, 2023 01:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

2 participants