Skip to content

Improve VectorTypeAttribute(dims) docs #5301

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.

Sign up for GitHub

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 1 commit into from
Jul 11, 2020
Merged

Improve VectorTypeAttribute(dims) docs #5301

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion src/Microsoft.ML.Data/Data/SchemaDefinition.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,9 @@ public VectorTypeAttribute(int size)
}

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