-
Notifications
You must be signed in to change notification settings - Fork 5.1k
Tensor doc improvements #116562
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
Tensor doc improvements #116562
Conversation
src/libraries/System.Numerics.Tensors/src/System/Numerics/Tensors/netcore/IReadOnlyTensor.cs
Outdated
Show resolved
Hide resolved
Tagging subscribers to this area: @dotnet/area-system-numerics-tensors |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This PR enhances XML documentation for Tensor interfaces by clarifying property summaries, adding <value>
tags, and standardizing punctuation in example remarks.
- Improved summaries and added
<value>
tags forHasAnyDenseDimensions
andIsDense
properties. - Standardized wording (“one element” instead of “1 element”) and punctuation in remarks.
- Added missing period in the
ToDenseTensor
example.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
File | Description |
---|---|
src/libraries/System.Numerics.Tensors/src/System/Numerics/Tensors/netcore/IReadOnlyTensor_1.cs | Added period to example remark in ToDenseTensor docs |
src/libraries/System.Numerics.Tensors/src/System/Numerics/Tensors/netcore/IReadOnlyTensor.cs | Updated property summaries, added <value> tags, and reworded remarks |
Comments suppressed due to low confidence (1)
src/libraries/System.Numerics.Tensors/src/System/Numerics/Tensors/netcore/IReadOnlyTensor_1.cs:89
- The example shows
Strides: [4, 1]
for a dense 2×2 Tensor, but correct contiguous strides should be[2, 1]
. Please update the remark to reflect the accurate stride values.
/// <para>For a 2x2 Tensor, this would mean it has <c>FlattendLength: 4; Lengths: [2, 2]; Strides: [4, 1]</c>. The elements would be sequentially accessed via indexes: <c>[0, 0]; [0, 1]; [1, 0]; [1, 1]</c>.</para>
src/libraries/System.Numerics.Tensors/src/System/Numerics/Tensors/netcore/IReadOnlyTensor.cs
Outdated
Show resolved
Hide resolved
…ors/netcore/IReadOnlyTensor.cs
No description provided.