[doc] Update kernel_function #6794
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for docsite-preview ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
|
|
for more information, see https://pre-commit.ci
neozhaoliang
reviewed
Dec 2, 2022
Co-authored-by: Zhao Liang <[email protected]>
for more information, see https://pre-commit.ci
Comment on lines
173
to
192
| #### Matrix Fields | ||
| We can use the ti.Matrix() function to declare our own [Matrix Field](https://docs.taichi-lang.org/docs/master/field#matrix-fields) and pass it into the kernel. This also works for [Vector Fields](https://docs.taichi-lang.org/docs/master/field#vector-fields) | ||
|
|
||
| In the following example, we declare a Matrix Field, generate its values, and pass it into `myKernel()`: | ||
|
|
||
| ```python | ||
| import taichi as ti | ||
| ti.init() | ||
|
|
||
|
|
||
| @ti.kernel | ||
| def myKernel(a: ti.Matrix.field): | ||
| for i in ti.grouped(a): | ||
| a[i] = [[1,1,1], [1,1,1]] | ||
|
|
||
| a = ti.Matrix.field(n=2, m=3, dtype=ti.f32, shape=(2, 2)) #Declares a 2x2 matrix field, with each of its elements being a 3x2 matrix | ||
| myKernel(a) | ||
| print(a[0][0,0]) #prints 1 | ||
|
|
||
| ``` |
There was a problem hiding this comment.
Suggested change
| #### Matrix Fields | |
| We can use the ti.Matrix() function to declare our own [Matrix Field](https://docs.taichi-lang.org/docs/master/field#matrix-fields) and pass it into the kernel. This also works for [Vector Fields](https://docs.taichi-lang.org/docs/master/field#vector-fields) | |
| In the following example, we declare a Matrix Field, generate its values, and pass it into `myKernel()`: | |
| ```python | |
| import taichi as ti | |
| ti.init() | |
| @ti.kernel | |
| def myKernel(a: ti.Matrix.field): | |
| for i in ti.grouped(a): | |
| a[i] = [[1,1,1], [1,1,1]] | |
| a = ti.Matrix.field(n=2, m=3, dtype=ti.f32, shape=(2, 2)) #Declares a 2x2 matrix field, with each of its elements being a 3x2 matrix | |
| myKernel(a) | |
| print(a[0][0,0]) #prints 1 | |
| ``` |
I'm sorry, Matrix.Field is a function call, not a valid type hint. We should better not mention it here.
| @@ -262,7 +342,7 @@ All Taichi functions are force-inlined. Therefore, no runtime recursion is allow | |||
|
|
|||
| ### Arguments | |||
|
|
|||
| A Taichi function can have multiple arguments, supporting scalar, `ti.Matrix`, `ti.Vector`, `ti.types.ndarray()`, `ti.template()`, `ti.field`, and `ti.Struct` as argument types. Note that some of the restrictions on a kernel's arguments do not apply here: | |||
| A Taichi function can have multiple arguments, supporting [Scalar](https://docs.taichi-lang.org/docs/master/field#scalar-fields), [ti.Matrix](https://docs.taichi-lang.org/docs/master/field#matrix-fields), [ti.Vector](https://docs.taichi-lang.org/docs/master/field#vector-fields), `ti.types.ndarray()`, `ti.template()`, and [ti.Struct](https://docs.taichi-lang.org/docs/master/field#struct-fields) as argument types. Note that some of the restrictions on a kernel's arguments do not apply here: | |||
There was a problem hiding this comment.
Suggested change
| A Taichi function can have multiple arguments, supporting [Scalar](https://docs.taichi-lang.org/docs/master/field#scalar-fields), [ti.Matrix](https://docs.taichi-lang.org/docs/master/field#matrix-fields), [ti.Vector](https://docs.taichi-lang.org/docs/master/field#vector-fields), `ti.types.ndarray()`, `ti.template()`, and [ti.Struct](https://docs.taichi-lang.org/docs/master/field#struct-fields) as argument types. Note that some of the restrictions on a kernel's arguments do not apply here: | |
| A Taichi function can have multiple arguments, supporting [Scalar](https://docs.taichi-lang.org/docs/master/field#scalar-fields), [ti.Matrix](https://docs.taichi-lang.org/docs/master/field#matrix-fields), [ti.Vector](https://docs.taichi-lang.org/docs/master/field#vector-fields), `ti.types.ndarray()`, `ti.template()`, and [ti.Struct](https://docs.taichi-lang.org/docs/master/field#struct-fields) as argument types. Note that some of the restrictions on a kernel's arguments do not apply here: |
I'm afraid that Vector and Matrix are not Vector/Matrix fields; the ref links are not leading to the exact places. Can we remove them for now?
Co-authored-by: Zhao Liang <[email protected]>
Co-authored-by: Zhao Liang <[email protected]>
Co-authored-by: Zhao Liang <[email protected]>
Co-authored-by: Zhao Liang <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Cleaned up wording and Format, added some extra informative code examples the user can interact with to get a better feeling for the concepts, added extra links to core concepts in previous Taichi documentation.