Skip to content

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

Merged
merged 2 commits into from
Jun 21, 2025
Merged

Tensor doc improvements #116562

merged 2 commits into from
Jun 21, 2025

Conversation

gewarren
Copy link
Contributor

No description provided.

@Copilot Copilot AI review requested due to automatic review settings June 11, 2025 22:58
Copy link
Contributor

Tagging subscribers to this area: @dotnet/area-system-numerics-tensors
See info in area-owners.md if you want to be subscribed.

Copy link
Contributor

@Copilot Copilot AI left a 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 for HasAnyDenseDimensions and IsDense 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>

@gewarren gewarren merged commit 4314ca3 into dotnet:main Jun 21, 2025
81 of 86 checks passed
@gewarren gewarren deleted the docs-0611 branch June 21, 2025 06:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants