TensorString Class

Definition

Namespace:

Windows.AI.MachineLearning

A string tensor object.

public ref class TensorString sealed : ITensor, IClosable, IMemoryBuffer

/// [Windows.Foundation.Metadata.ContractVersion(Windows.AI.MachineLearning.MachineLearningContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class TensorString final : ITensor, IClosable, IMemoryBuffer

[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.AI.MachineLearning.MachineLearningContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class TensorString : System.IDisposable, ITensor, IMemoryBuffer

Public NotInheritable Class TensorString
Implements IDisposable, IMemoryBuffer, ITensor

Inheritance

Object Platform::Object IInspectable TensorString

Attributes

ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Implements

ILearningModelFeatureValue ITensor IClosable IDisposable IMemoryBuffer

Windows requirements

Device family	Windows 10, version 1809 (introduced in 10.0.17763.0)
API contract	Windows.AI.MachineLearning.MachineLearningContract (introduced in v1.0)

Remarks

A tensor is a multi-dimensional array of values. A string tensor is a tensor of string values.

The layout of tensors is row-major, with tightly packed contiguous data representing each dimension. The total size of a tensor is the product of the size of each dimension.

Windows Server

To use this API on Windows Server, you must use Windows Server 2019 with Desktop Experience.

Thread safety

This API is thread-safe.

Version history

Windows version	SDK version	Value added
1903	18362	CreateFromShapeArrayAndDataArray

Properties

Kind	Returns the kind of the feature.
Shape	Returns the count and size of each dimension.
TensorKind	Returns the data type of the tensor.

Methods

Close()	If there are no outstanding IMemoryBufferReference objects created from this object, Close will dispose of the object and destroy its associated resources. Otherwise, Close will detach itself from its associated resources and they will be destroyed when the last IMemoryBufferReference is closed.
Create()	Creates a string tensor object without allocating a buffer.
Create(IIterable<Int64>)	Creates a string tensor object and allocates a buffer of size shape.
CreateFromArray(IIterable<Int64>, String[])	Creates a string tensor object, allocates a buffer of size shape, and copies all of data into it.
CreateFromIterable(IIterable<Int64>, IIterable<String>)	Creates a string tensor object, allocates a buffer of size shape, and copies all of data into it.
CreateFromShapeArrayAndDataArray(Int64[], String[])	Creates a string tensor object, allocates a buffer of size shape, and copies all of data into it.
CreateReference()	This method is disallowed on TensorString objects and should not be used.
Dispose()	Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
GetAsVectorView()	Returns a read-only view of the data.

See also

• Windows ML
• Windows ML samples (GitHub)