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] Add doc about struct arguments #7959

Merged
merged 6 commits into from
May 10, 2023

Conversation

lin-hitonami
Copy link
Contributor

@lin-hitonami lin-hitonami commented May 9, 2023

Issue: #

Brief Summary

🤖 Generated by Copilot at adf95e4

This pull request improves the documentation of ti.kernel and ti.func by using the new ti.types module and showing how to work with structs and matrices.

Walkthrough

🤖 Generated by Copilot at adf95e4

  • Update the argument and return value types of kernels and functions to use the ti.types module (link, link, link, link, link)
  • Add an example of passing a struct with a matrix to a kernel by value in docs/lang/articles/kernels/kernel_function.md (link)

@netlify
Copy link

netlify bot commented May 9, 2023

Deploy Preview for docsite-preview ready!

Name Link
🔨 Latest commit 19943ee
🔍 Latest deploy log https://app.netlify.com/sites/docsite-preview/deploys/645b08de5237970009463a05
😎 Deploy Preview https://deploy-preview-7959--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 settings.

@lin-hitonami lin-hitonami added this to the v1.6.0 milestone May 9, 2023
lin-hitonami and others added 2 commits May 9, 2023 16:34
Copy link
Contributor

@neozhaoliang neozhaoliang left a comment

Choose a reason for hiding this comment

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

LGTM!

Co-authored-by: Zhao Liang <mathzhaoliang@gmail.com>
@lin-hitonami lin-hitonami merged commit 4a24872 into taichi-dev:master May 10, 2023
@lin-hitonami lin-hitonami deleted the struct-arg-doc branch May 10, 2023 03:57
feisuzhu pushed a commit that referenced this pull request May 10, 2023
Issue: #

### Brief Summary

<!--
copilot:summary
-->
### <samp>🤖 Generated by Copilot at adf95e4</samp>

This pull request improves the documentation of `ti.kernel` and
`ti.func` by using the new `ti.types` module and showing how to work
with structs and matrices.

### Walkthrough

<!--
copilot:walkthrough
-->
### <samp>🤖 Generated by Copilot at adf95e4</samp>

* Update the argument and return value types of kernels and functions to
use the `ti.types` module
([link](https://github.com/taichi-dev/taichi/pull/7959/files?diff=unified&w=0#diff-305d66d1c231266cb14a0d2b166363840f782874eb6c5b3d5d4e15e08f3cb04cL96-R98),
[link](https://github.com/taichi-dev/taichi/pull/7959/files?diff=unified&w=0#diff-305d66d1c231266cb14a0d2b166363840f782874eb6c5b3d5d4e15e08f3cb04cL138-R158),
[link](https://github.com/taichi-dev/taichi/pull/7959/files?diff=unified&w=0#diff-305d66d1c231266cb14a0d2b166363840f782874eb6c5b3d5d4e15e08f3cb04cL279-R298),
[link](https://github.com/taichi-dev/taichi/pull/7959/files?diff=unified&w=0#diff-305d66d1c231266cb14a0d2b166363840f782874eb6c5b3d5d4e15e08f3cb04cL287-R306),
[link](https://github.com/taichi-dev/taichi/pull/7959/files?diff=unified&w=0#diff-305d66d1c231266cb14a0d2b166363840f782874eb6c5b3d5d4e15e08f3cb04cL300-R319))
* Add an example of passing a struct with a matrix to a kernel by value
in `docs/lang/articles/kernels/kernel_function.md`
([link](https://github.com/taichi-dev/taichi/pull/7959/files?diff=unified&w=0#diff-305d66d1c231266cb14a0d2b166363840f782874eb6c5b3d5d4e15e08f3cb04cR112-R130))

---------

Co-authored-by: Zhao Liang <mathzhaoliang@gmail.com>
quadpixels pushed a commit to quadpixels/taichi that referenced this pull request May 13, 2023
Issue: #

### Brief Summary

<!--
copilot:summary
-->
### <samp>🤖 Generated by Copilot at adf95e4</samp>

This pull request improves the documentation of `ti.kernel` and
`ti.func` by using the new `ti.types` module and showing how to work
with structs and matrices.

### Walkthrough

<!--
copilot:walkthrough
-->
### <samp>🤖 Generated by Copilot at adf95e4</samp>

* Update the argument and return value types of kernels and functions to
use the `ti.types` module
([link](https://github.com/taichi-dev/taichi/pull/7959/files?diff=unified&w=0#diff-305d66d1c231266cb14a0d2b166363840f782874eb6c5b3d5d4e15e08f3cb04cL96-R98),
[link](https://github.com/taichi-dev/taichi/pull/7959/files?diff=unified&w=0#diff-305d66d1c231266cb14a0d2b166363840f782874eb6c5b3d5d4e15e08f3cb04cL138-R158),
[link](https://github.com/taichi-dev/taichi/pull/7959/files?diff=unified&w=0#diff-305d66d1c231266cb14a0d2b166363840f782874eb6c5b3d5d4e15e08f3cb04cL279-R298),
[link](https://github.com/taichi-dev/taichi/pull/7959/files?diff=unified&w=0#diff-305d66d1c231266cb14a0d2b166363840f782874eb6c5b3d5d4e15e08f3cb04cL287-R306),
[link](https://github.com/taichi-dev/taichi/pull/7959/files?diff=unified&w=0#diff-305d66d1c231266cb14a0d2b166363840f782874eb6c5b3d5d4e15e08f3cb04cL300-R319))
* Add an example of passing a struct with a matrix to a kernel by value
in `docs/lang/articles/kernels/kernel_function.md`
([link](https://github.com/taichi-dev/taichi/pull/7959/files?diff=unified&w=0#diff-305d66d1c231266cb14a0d2b166363840f782874eb6c5b3d5d4e15e08f3cb04cR112-R130))

---------

Co-authored-by: Zhao Liang <mathzhaoliang@gmail.com>
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.

3 participants