Skip to content

Commit 1b44be7

Browse files
Improve VectorTypeAttribute(dimensions) docs (#5301)
1 parent 6415f7f commit 1b44be7

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

src/Microsoft.ML.Data/Data/SchemaDefinition.cs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,9 @@ public VectorTypeAttribute(int size)
8080
}
8181

8282
/// <summary>
83-
/// Mark member with expected dimensions of array.
83+
/// Mark member with expected dimensions of array. Notice that this attribute is expected to be added to one dimensional arrays,
84+
/// and it shouldn't be added to multidimensional arrays. Internally, ML.NET will use the shape information provided as the
85+
/// "dimensions" param of this constructor, to use it as a multidimensional array.
8486
/// </summary>
8587
/// <param name="dimensions">Dimensions of array. All values should be non-negative.
8688
/// A zero value indicates that the vector type is considered to have unknown length along that dimension.</param>

0 commit comments

Comments
 (0)