Skip to content

Update System.Numerics.Tensors PACKAGE.md to reflect current library capabilities#118512

Merged
stephentoub merged 4 commits intomainfrom
copilot/fix-ca283bf1-c372-4884-b242-2d977f74f665
Aug 8, 2025
Merged

Update System.Numerics.Tensors PACKAGE.md to reflect current library capabilities#118512
stephentoub merged 4 commits intomainfrom
copilot/fix-ca283bf1-c372-4884-b242-2d977f74f665

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Aug 8, 2025

The PACKAGE.md file for System.Numerics.Tensors was outdated and no longer accurately described the library's current capabilities. The documentation incorrectly suggested the library only worked with ReadOnlySpan<float> and only provided TensorPrimitives, when in fact the library has evolved to include a comprehensive set of generic tensor types and operations.

Changes Made

Updated Library Description:

  • Changed from describing operations on "tensors represented as spans" to describing both "high-level tensor types and low-level primitives for working with multi-dimensional numeric data"
  • Clarified that the library offers both approaches for different use cases

Enhanced Key Features:

  • Added mention of high-level tensor types: Tensor<T>, TensorSpan<T>, ReadOnlyTensorSpan<T>
  • Highlighted generic support for various numeric types (not just float)
  • Maintained existing feature descriptions while adding context about SIMD acceleration

Improved Example Code:

  • Kept the original TensorPrimitives example to show continuity
  • Added new example demonstrating high-level Tensor operations with multi-dimensional arrays
  • Both examples compile and work correctly with the current API

Updated Main Types Section:

  • Expanded from listing only TensorPrimitives to include all major types:
    • TensorPrimitives - Low-level span operations
    • Tensor<T> - Generic tensor class
    • TensorSpan<T> - Mutable span-like view
    • ReadOnlyTensorSpan<T> - Read-only span-like view
    • Tensor - Static class with high-level operations

The updated documentation now accurately reflects the library's evolution from a simple span-based primitives library to a comprehensive tensor computation framework while maintaining backward compatibility information.


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

@stephentoub stephentoub changed the title [WIP] Update the PACKAGE.md file for the System.Numerics.Tensors library. It is out of date with regards to the capabilities of the library. For example, it's no longer just about ReadOnlySpan<float> but has many generic methods. And it's not just about `T... [WIP] Update the PACKAGE.md file for the System.Numerics.Tensors library Aug 8, 2025
@github-actions github-actions Bot added the needs-area-label An area label is needed to ensure this gets routed to the appropriate area owners label Aug 8, 2025
…capabilities

Co-authored-by: stephentoub <2642209+stephentoub@users.noreply.github.com>
Copilot AI changed the title [WIP] Update the PACKAGE.md file for the System.Numerics.Tensors library Update System.Numerics.Tensors PACKAGE.md to reflect current library capabilities Aug 8, 2025
Copilot AI requested a review from stephentoub August 8, 2025 01:44
@stephentoub stephentoub marked this pull request as ready for review August 8, 2025 01:58
Copy link
Copy Markdown
Contributor

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

Updates the System.Numerics.Tensors PACKAGE.md documentation to accurately reflect the library's current capabilities, expanding from a description focused solely on span-based primitives to include the comprehensive tensor types and operations now available.

  • Updated library description to highlight both high-level tensor types and low-level primitives
  • Enhanced examples to demonstrate both TensorPrimitives and high-level Tensor operations
  • Expanded main types section to include all major tensor types and operations

Comment thread src/libraries/System.Numerics.Tensors/src/PACKAGE.md Outdated
Co-authored-by: Tanner Gooding <tagoo@outlook.com>
@stephentoub stephentoub added area-System.Numerics.Tensors and removed needs-area-label An area label is needed to ensure this gets routed to the appropriate area owners labels Aug 8, 2025
@dotnet-policy-service
Copy link
Copy Markdown
Contributor

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

@stephentoub
Copy link
Copy Markdown
Member

@copilot, please fix the linting errors:

Error: src/libraries/System.Numerics.Tensors/src/PACKAGE.md:57:90 MD009/no-trailing-spaces Trailing spaces [Expected: 0; Actual: 2]

Co-authored-by: stephentoub <2642209+stephentoub@users.noreply.github.com>
Copy link
Copy Markdown
Contributor Author

Copilot AI commented Aug 8, 2025

@copilot, please fix the linting errors:

Error: src/libraries/System.Numerics.Tensors/src/PACKAGE.md:57:90 MD009/no-trailing-spaces Trailing spaces [Expected: 0; Actual: 2]

...

Fixed trailing spaces linting error in commit 124e127.

@stephentoub
Copy link
Copy Markdown
Member

/ba-g markdown only

@stephentoub stephentoub merged commit 5688eab into main Aug 8, 2025
13 of 14 checks passed
@stephentoub stephentoub deleted the copilot/fix-ca283bf1-c372-4884-b242-2d977f74f665 branch August 8, 2025 16:34
@github-actions github-actions Bot locked and limited conversation to collaborators Sep 8, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants