Tensor wave 1 API's. #101196

michaelgsharp · 2024-04-17T17:26:30Z

This is the initial PR for the Tensor Prototype. The design doc is here, and its still in discussion so updates will be coming from the result of those discussions. Further updates will also be coming in regards to error handling/etc, but this will allow for preliminary reviews.

dotnet-issue-labeler · 2024-04-17T17:26:36Z

Note regarding the new-api-needs-documentation label:

This serves as a reminder for when your PR is modifying a ref *.cs file and adding/modifying public APIs, please make sure the API implementation in the src *.cs file is documented with triple slash comments, so the PR reviewers can sign off that change.

dotnet-policy-service · 2024-04-17T17:27:09Z

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

stephentoub

I've skimmed through some. Will review the rest in a bit.

src/libraries/System.Numerics.Tensors/src/System/NativeIndex.cs

src/libraries/System.Numerics.Tensors/src/System/Numerics/Tensors/netcore/Tensor.Factory.cs

src/libraries/System.Numerics.Tensors/src/System/Numerics/Tensors/netcore/Tensor.cs

stephentoub · 2024-04-23T01:08:16Z

src/libraries/System.Numerics.Tensors/src/System/Numerics/Tensors/netcore/Tensor.Factory.cs

+{
+    public static partial class Tensor
+    {
+        public static Tensor<T> Create<T>(bool mustPin, ReadOnlySpan<nint> lengths)


Missing XML comments on a bunch of these public APIs

src/libraries/System.Numerics.Tensors/src/System/Numerics/Tensors/netcore/Tensor.Factory.cs

src/libraries/System.Numerics.Tensors/src/System/Numerics/Tensors/netcore/Tensor.cs

src/libraries/System.Numerics.Tensors/src/System/Numerics/Tensors/netcore/TensorExtensions.cs

src/libraries/System.Numerics.Tensors/src/System/NativeIndex.cs

src/libraries/System.Numerics.Tensors/ref/System.Numerics.Tensors.netcore.cs

tannergooding · 2024-05-15T15:32:07Z

src/libraries/System.Numerics.Tensors/ref/System.Numerics.Tensors.netcore.cs

+            public bool MoveNext() { throw null; }
+        }
+    }
+    public static partial class Tensor


Most of these APIs that both take and return some form of Span are missing scoped where relevant.

Many of the span APIs are also unnecessarily mutable, for example Add should only be taking in ReadOnlyTensorSpan while AddInPlace should take one TensorSpan and one ReadOnlyTensorSpan.

I'm fine with this class in particular being handled in a follow up PR, but I think it's important to do that cleanup prior to the first preview.

src/libraries/System.Numerics.Tensors/ref/System.Numerics.Tensors.netcore.cs

tannergooding · 2024-05-15T15:37:42Z

src/libraries/System.Numerics.Tensors/ref/System.Numerics.Tensors.netcore.cs

+        static System.Numerics.Tensors.Tensor<T> System.Numerics.Tensors.ITensor<System.Numerics.Tensors.Tensor<T>, T>.CreateUninitialized(scoped System.ReadOnlySpan<nint> lengths, scoped System.ReadOnlySpan<nint> strides, bool pinned) { throw null; }
+        public string ToString(scoped System.ReadOnlySpan<nint> maximumLengths) { throw null; }
+        public bool TryCopyTo(scoped System.Numerics.Tensors.TensorSpan<T> destination) { throw null; }
+        public bool TryFlattenTo(scoped System.Span<T> destination) { throw null; }


Likewise fine with it being cleaned up in a separate PR, but scoped shouldn't be needed on any API where the underlying ref field cannot be captured.

Tensor<T> cannot have a ref field and most of these APIs do not return a ref. It's different for TensorSpan<T> since the hidden this parameter allows the ref to be captured.

src/libraries/System.Numerics.Tensors/src/System/Numerics/Tensors/netcore/ReadOnlyTensorSpan.cs

tannergooding

I think there's a lot of cleanup that still needs to be done in the form of optimization work, validating inputs are correct/sensible to the BCL/FDG standards, ensuring we do the relevant security audit, etc

But, this looks like it now matches the so far reviewed API proposal and should be good to merge to keep the PR from growing exponentially. We should ideally log issues to track most of this additional work/cleanup prior to merging

tannergooding · 2024-05-15T16:13:10Z

Audit the usage of scoped in the Tensor APIs #102266 - Audit the usage of scoped in the Tensor APIs
Ensure argument validation is being done for the Tensor APIs #102267 - Ensure argument validation is being done for the Tensor APIs
Optimize the layout of the Tensor types #102268 - Optimize the layout of the Tensor types

michaelgsharp requested review from jeffhandley, NiklasGustafsson, stephentoub, eiriktsarpalis, ericstj, tannergooding, JakeRadMSFT and luisquintanilla April 17, 2024 17:26

michaelgsharp self-assigned this Apr 17, 2024

dotnet-issue-labeler bot added area-System.Numerics new-api-needs-documentation labels Apr 17, 2024

build-analysis bot mentioned this pull request Apr 17, 2024

Intermittent build failure in AfterSourceBuild: "Could not write state file" #76488

Open

michaelgsharp force-pushed the tensor-prototype branch 2 times, most recently from a4ce322 to 61faee1 Compare April 22, 2024 21:17

michaelgsharp marked this pull request as ready for review April 22, 2024 21:17

stephentoub reviewed Apr 22, 2024

View reviewed changes

stephentoub reviewed Apr 23, 2024

View reviewed changes

michaelgsharp changed the title ~~Tensor prototype~~ Tensor wave 1 API's. Apr 23, 2024

tannergooding reviewed Apr 26, 2024

View reviewed changes

src/libraries/System.Numerics.Tensors/src/System/NativeIndex.cs Outdated Show resolved Hide resolved

This was referenced Apr 26, 2024

Cannot find 'arm64-v8a' device dotnet/dnceng#2284

Open

WasmTestOnChrome-System.Runtime.Tests.WorkItemExecution fails with exit code 3221226505 #101464

Closed

Dead lettering tests #101524

Open

[WASI][AOT] LLVM ERROR: out of memory #101533

Open

michaelgsharp added 12 commits May 14, 2024 14:09

organizational changes

3aad0ae

ref and implicit broadcast

c31c376

build failures

f68ea45

updates from PR comments

b68df66

error text moved to strings.resx

58cfa63

exception strings moved to strings.resc

b004517

comments from PR

4645fe6

more fixes from PR and API review

53f21a8

rebase on main. XML comments. API updates

c093979

NIndex,NRange,RO/TensorSpan API updates

ff72361

IROTensor,ITensor,Tensor API updates

94674f1

changes from pr comments

7872a18

michaelgsharp force-pushed the tensor-prototype branch from dfc0745 to 7872a18 Compare May 14, 2024 20:09