Skip to content

Commit eace673

Browse files
author
VSC-Service-Account
committed
CI Update
 Build.Reason:Manual by Alma Jenks Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=330314&view=results source_repo.branch:master source_repo.csvPath:bundlepackages/ml-dotnet source_repo.url:https://apidrop.visualstudio.com/binaries/_git/mrefconfig
1 parent be1848a commit eace673

File tree

74 files changed

+619
-227
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

74 files changed

+619
-227
lines changed

‎dotnet/xml/FrameworksIndex/ml-dotnet.xml

+23-136
Large diffs are not rendered by default.

‎dotnet/xml/Microsoft.ML.Calibrators/NaiveCalibratorEstimator.xml

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
<Interfaces />
1818
<Docs>
1919
<summary>
20-
The naive binning-based calbirator estimator.
20+
The naive binning-based calibrator estimator.
2121
</summary>
2222
<remarks>
2323
It divides the range of the outputs into equally sized bins. In each bin,

‎dotnet/xml/Microsoft.ML.Data/ImageLoadingEstimator.xml

+2-2
Original file line numberDiff line numberDiff line change
@@ -27,14 +27,14 @@
2727
| -- | -- |
2828
| Does this estimator need to look at the data to train its parameters? | No |
2929
| Input column data type | [Text](<xref:Microsoft.ML.Data.TextDataViewType>) |
30-
| Output column data type | <xref:System.Drawing.Bitmap> |
30+
| Output column data type | <xref:Microsoft.ML.Data.MLImage> |
3131
| Required NuGet in addition to Microsoft.ML | Microsoft.ML.ImageAnalytics |
3232
| Exportable to ONNX | No |
3333
3434
The resulting <xref:Microsoft.ML.Data.ImageLoadingTransformer> creates a new column, named as specified in the output column name parameters, and
3535
loads in it images specified in the input column.
3636
Loading is the first step of almost every pipeline that does image processing, and further analysis on images.
37-
The images to load need to be in the formats supported by <xref:System.Drawing.Bitmap>.
37+
The images to load need to be in the formats supported by <xref:Microsoft.ML.Data.MLImage> implementation.
3838
For end-to-end image processing pipelines, and scenarios in your applications, see the
3939
[examples](https://github.com/dotnet/machinelearning-samples/tree/main/samples/csharp/getting-started) in the machinelearning-samples github repository.</a>
4040

‎dotnet/xml/Microsoft.ML.Data/MLImage.xml

+293
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,293 @@
1+
<Type Name="MLImage" FullName="Microsoft.ML.Data.MLImage">
2+
<TypeSignature Language="C#" Value="public sealed class MLImage : IDisposable" />
3+
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit MLImage extends System.Object implements class System.IDisposable" />
4+
<TypeSignature Language="DocId" Value="T:Microsoft.ML.Data.MLImage" />
5+
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class MLImage&#xA;Implements IDisposable" />
6+
<TypeSignature Language="F#" Value="type MLImage = class&#xA; interface IDisposable" />
7+
<AssemblyInfo>
8+
<AssemblyName>Microsoft.ML.ImageAnalytics</AssemblyName>
9+
<AssemblyVersion>1.0.0.0</AssemblyVersion>
10+
</AssemblyInfo>
11+
<Base>
12+
<BaseTypeName>System.Object</BaseTypeName>
13+
</Base>
14+
<Interfaces>
15+
<Interface>
16+
<InterfaceName>System.IDisposable</InterfaceName>
17+
</Interface>
18+
</Interfaces>
19+
<Docs>
20+
<summary>
21+
Provide interfaces for imaging operations.
22+
</summary>
23+
<remarks>To be added.</remarks>
24+
</Docs>
25+
<Members>
26+
<Member MemberName="BitsPerPixel">
27+
<MemberSignature Language="C#" Value="public int BitsPerPixel { get; }" />
28+
<MemberSignature Language="ILAsm" Value=".property instance int32 BitsPerPixel" />
29+
<MemberSignature Language="DocId" Value="P:Microsoft.ML.Data.MLImage.BitsPerPixel" />
30+
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property BitsPerPixel As Integer" />
31+
<MemberSignature Language="F#" Value="member this.BitsPerPixel : int" Usage="Microsoft.ML.Data.MLImage.BitsPerPixel" />
32+
<MemberType>Property</MemberType>
33+
<AssemblyInfo>
34+
<AssemblyName>Microsoft.ML.ImageAnalytics</AssemblyName>
35+
<AssemblyVersion>1.0.0.0</AssemblyVersion>
36+
</AssemblyInfo>
37+
<ReturnValue>
38+
<ReturnType>System.Int32</ReturnType>
39+
</ReturnValue>
40+
<Docs>
41+
<summary>
42+
Gets how many bits per pixel used by current image object.
43+
</summary>
44+
<value>To be added.</value>
45+
<remarks>To be added.</remarks>
46+
</Docs>
47+
</Member>
48+
<Member MemberName="CreateFromFile">
49+
<MemberSignature Language="C#" Value="public static Microsoft.ML.Data.MLImage CreateFromFile (string imagePath);" />
50+
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.ML.Data.MLImage CreateFromFile(string imagePath) cil managed" />
51+
<MemberSignature Language="DocId" Value="M:Microsoft.ML.Data.MLImage.CreateFromFile(System.String)" />
52+
<MemberSignature Language="VB.NET" Value="Public Shared Function CreateFromFile (imagePath As String) As MLImage" />
53+
<MemberSignature Language="F#" Value="static member CreateFromFile : string -&gt; Microsoft.ML.Data.MLImage" Usage="Microsoft.ML.Data.MLImage.CreateFromFile imagePath" />
54+
<MemberType>Method</MemberType>
55+
<AssemblyInfo>
56+
<AssemblyName>Microsoft.ML.ImageAnalytics</AssemblyName>
57+
<AssemblyVersion>1.0.0.0</AssemblyVersion>
58+
</AssemblyInfo>
59+
<ReturnValue>
60+
<ReturnType>Microsoft.ML.Data.MLImage</ReturnType>
61+
</ReturnValue>
62+
<Parameters>
63+
<Parameter Name="imagePath" Type="System.String" />
64+
</Parameters>
65+
<Docs>
66+
<param name="imagePath">The image file path to create the image from.</param>
67+
<summary>
68+
Create a new MLImage instance from a stream.
69+
</summary>
70+
<returns>MLImage object.</returns>
71+
<remarks>To be added.</remarks>
72+
</Docs>
73+
</Member>
74+
<Member MemberName="CreateFromPixels">
75+
<MemberSignature Language="C#" Value="public static Microsoft.ML.Data.MLImage CreateFromPixels (int width, int height, Microsoft.ML.Data.MLPixelFormat pixelFormat, ReadOnlySpan&lt;byte&gt; imagePixelData);" />
76+
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.ML.Data.MLImage CreateFromPixels(int32 width, int32 height, valuetype Microsoft.ML.Data.MLPixelFormat pixelFormat, valuetype System.ReadOnlySpan`1&lt;unsigned int8&gt; imagePixelData) cil managed" />
77+
<MemberSignature Language="DocId" Value="M:Microsoft.ML.Data.MLImage.CreateFromPixels(System.Int32,System.Int32,Microsoft.ML.Data.MLPixelFormat,System.ReadOnlySpan{System.Byte})" />
78+
<MemberSignature Language="VB.NET" Value="Public Shared Function CreateFromPixels (width As Integer, height As Integer, pixelFormat As MLPixelFormat, imagePixelData As ReadOnlySpan(Of Byte)) As MLImage" />
79+
<MemberSignature Language="F#" Value="static member CreateFromPixels : int * int * Microsoft.ML.Data.MLPixelFormat * ReadOnlySpan&lt;byte&gt; -&gt; Microsoft.ML.Data.MLImage" Usage="Microsoft.ML.Data.MLImage.CreateFromPixels (width, height, pixelFormat, imagePixelData)" />
80+
<MemberType>Method</MemberType>
81+
<AssemblyInfo>
82+
<AssemblyName>Microsoft.ML.ImageAnalytics</AssemblyName>
83+
<AssemblyVersion>1.0.0.0</AssemblyVersion>
84+
</AssemblyInfo>
85+
<ReturnValue>
86+
<ReturnType>Microsoft.ML.Data.MLImage</ReturnType>
87+
</ReturnValue>
88+
<Parameters>
89+
<Parameter Name="width" Type="System.Int32" />
90+
<Parameter Name="height" Type="System.Int32" />
91+
<Parameter Name="pixelFormat" Type="Microsoft.ML.Data.MLPixelFormat" />
92+
<Parameter Name="imagePixelData" Type="System.ReadOnlySpan&lt;System.Byte&gt;" />
93+
</Parameters>
94+
<Docs>
95+
<param name="width">The width of the image in pixels.</param>
96+
<param name="height">The height of the image in pixels.</param>
97+
<param name="pixelFormat">The pixel format to create the image with.</param>
98+
<param name="imagePixelData">The pixels data to create the image from.</param>
99+
<summary>
100+
Creates MLImage object from the pixel data span.
101+
</summary>
102+
<returns>MLImage object.</returns>
103+
<remarks>To be added.</remarks>
104+
</Docs>
105+
</Member>
106+
<Member MemberName="CreateFromStream">
107+
<MemberSignature Language="C#" Value="public static Microsoft.ML.Data.MLImage CreateFromStream (System.IO.Stream imageStream);" />
108+
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.ML.Data.MLImage CreateFromStream(class System.IO.Stream imageStream) cil managed" />
109+
<MemberSignature Language="DocId" Value="M:Microsoft.ML.Data.MLImage.CreateFromStream(System.IO.Stream)" />
110+
<MemberSignature Language="VB.NET" Value="Public Shared Function CreateFromStream (imageStream As Stream) As MLImage" />
111+
<MemberSignature Language="F#" Value="static member CreateFromStream : System.IO.Stream -&gt; Microsoft.ML.Data.MLImage" Usage="Microsoft.ML.Data.MLImage.CreateFromStream imageStream" />
112+
<MemberType>Method</MemberType>
113+
<AssemblyInfo>
114+
<AssemblyName>Microsoft.ML.ImageAnalytics</AssemblyName>
115+
<AssemblyVersion>1.0.0.0</AssemblyVersion>
116+
</AssemblyInfo>
117+
<ReturnValue>
118+
<ReturnType>Microsoft.ML.Data.MLImage</ReturnType>
119+
</ReturnValue>
120+
<Parameters>
121+
<Parameter Name="imageStream" Type="System.IO.Stream" />
122+
</Parameters>
123+
<Docs>
124+
<param name="imageStream">The stream to create the image from.</param>
125+
<summary>
126+
Create a new MLImage instance from a stream.
127+
</summary>
128+
<returns>MLImage object.</returns>
129+
<remarks>To be added.</remarks>
130+
</Docs>
131+
</Member>
132+
<Member MemberName="Dispose">
133+
<MemberSignature Language="C#" Value="public void Dispose ();" />
134+
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Dispose() cil managed" />
135+
<MemberSignature Language="DocId" Value="M:Microsoft.ML.Data.MLImage.Dispose" />
136+
<MemberSignature Language="VB.NET" Value="Public Sub Dispose ()" />
137+
<MemberSignature Language="F#" Value="abstract member Dispose : unit -&gt; unit&#xA;override this.Dispose : unit -&gt; unit" Usage="mLImage.Dispose " />
138+
<MemberType>Method</MemberType>
139+
<Implements>
140+
<InterfaceMember>M:System.IDisposable.Dispose</InterfaceMember>
141+
</Implements>
142+
<AssemblyInfo>
143+
<AssemblyName>Microsoft.ML.ImageAnalytics</AssemblyName>
144+
<AssemblyVersion>1.0.0.0</AssemblyVersion>
145+
</AssemblyInfo>
146+
<ReturnValue>
147+
<ReturnType>System.Void</ReturnType>
148+
</ReturnValue>
149+
<Parameters />
150+
<Docs>
151+
<summary>
152+
Disposes the image.
153+
</summary>
154+
<remarks>To be added.</remarks>
155+
</Docs>
156+
</Member>
157+
<Member MemberName="Height">
158+
<MemberSignature Language="C#" Value="public int Height { get; }" />
159+
<MemberSignature Language="ILAsm" Value=".property instance int32 Height" />
160+
<MemberSignature Language="DocId" Value="P:Microsoft.ML.Data.MLImage.Height" />
161+
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Height As Integer" />
162+
<MemberSignature Language="F#" Value="member this.Height : int" Usage="Microsoft.ML.Data.MLImage.Height" />
163+
<MemberType>Property</MemberType>
164+
<AssemblyInfo>
165+
<AssemblyName>Microsoft.ML.ImageAnalytics</AssemblyName>
166+
<AssemblyVersion>1.0.0.0</AssemblyVersion>
167+
</AssemblyInfo>
168+
<ReturnValue>
169+
<ReturnType>System.Int32</ReturnType>
170+
</ReturnValue>
171+
<Docs>
172+
<summary>
173+
Gets the image height in pixels.
174+
</summary>
175+
<value>To be added.</value>
176+
<remarks>To be added.</remarks>
177+
</Docs>
178+
</Member>
179+
<Member MemberName="PixelFormat">
180+
<MemberSignature Language="C#" Value="public Microsoft.ML.Data.MLPixelFormat PixelFormat { get; }" />
181+
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.ML.Data.MLPixelFormat PixelFormat" />
182+
<MemberSignature Language="DocId" Value="P:Microsoft.ML.Data.MLImage.PixelFormat" />
183+
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property PixelFormat As MLPixelFormat" />
184+
<MemberSignature Language="F#" Value="member this.PixelFormat : Microsoft.ML.Data.MLPixelFormat" Usage="Microsoft.ML.Data.MLImage.PixelFormat" />
185+
<MemberType>Property</MemberType>
186+
<AssemblyInfo>
187+
<AssemblyName>Microsoft.ML.ImageAnalytics</AssemblyName>
188+
<AssemblyVersion>1.0.0.0</AssemblyVersion>
189+
</AssemblyInfo>
190+
<ReturnValue>
191+
<ReturnType>Microsoft.ML.Data.MLPixelFormat</ReturnType>
192+
</ReturnValue>
193+
<Docs>
194+
<summary>
195+
Gets the pixel format for this Image.
196+
</summary>
197+
<value>To be added.</value>
198+
<remarks>To be added.</remarks>
199+
</Docs>
200+
</Member>
201+
<Member MemberName="Pixels">
202+
<MemberSignature Language="C#" Value="public ReadOnlySpan&lt;byte&gt; Pixels { get; }" />
203+
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.ReadOnlySpan`1&lt;unsigned int8&gt; Pixels" />
204+
<MemberSignature Language="DocId" Value="P:Microsoft.ML.Data.MLImage.Pixels" />
205+
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Pixels As ReadOnlySpan(Of Byte)" />
206+
<MemberSignature Language="F#" Value="member this.Pixels : ReadOnlySpan&lt;byte&gt;" Usage="Microsoft.ML.Data.MLImage.Pixels" />
207+
<MemberType>Property</MemberType>
208+
<AssemblyInfo>
209+
<AssemblyName>Microsoft.ML.ImageAnalytics</AssemblyName>
210+
<AssemblyVersion>1.0.0.0</AssemblyVersion>
211+
</AssemblyInfo>
212+
<ReturnValue>
213+
<ReturnType>System.ReadOnlySpan&lt;System.Byte&gt;</ReturnType>
214+
</ReturnValue>
215+
<Docs>
216+
<summary>
217+
Gets the image pixel data.
218+
</summary>
219+
<value>To be added.</value>
220+
<remarks>To be added.</remarks>
221+
</Docs>
222+
</Member>
223+
<Member MemberName="Save">
224+
<MemberSignature Language="C#" Value="public void Save (string imagePath);" />
225+
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Save(string imagePath) cil managed" />
226+
<MemberSignature Language="DocId" Value="M:Microsoft.ML.Data.MLImage.Save(System.String)" />
227+
<MemberSignature Language="VB.NET" Value="Public Sub Save (imagePath As String)" />
228+
<MemberSignature Language="F#" Value="member this.Save : string -&gt; unit" Usage="mLImage.Save imagePath" />
229+
<MemberType>Method</MemberType>
230+
<AssemblyInfo>
231+
<AssemblyName>Microsoft.ML.ImageAnalytics</AssemblyName>
232+
<AssemblyVersion>1.0.0.0</AssemblyVersion>
233+
</AssemblyInfo>
234+
<ReturnValue>
235+
<ReturnType>System.Void</ReturnType>
236+
</ReturnValue>
237+
<Parameters>
238+
<Parameter Name="imagePath" Type="System.String" />
239+
</Parameters>
240+
<Docs>
241+
<param name="imagePath">The path of the file to save the image to.</param>
242+
<summary>
243+
Save the current image to a file.
244+
</summary>
245+
<remarks>The saved image encoding will be detected from the file extension.</remarks>
246+
</Docs>
247+
</Member>
248+
<Member MemberName="Tag">
249+
<MemberSignature Language="C#" Value="public string Tag { get; set; }" />
250+
<MemberSignature Language="ILAsm" Value=".property instance string Tag" />
251+
<MemberSignature Language="DocId" Value="P:Microsoft.ML.Data.MLImage.Tag" />
252+
<MemberSignature Language="VB.NET" Value="Public Property Tag As String" />
253+
<MemberSignature Language="F#" Value="member this.Tag : string with get, set" Usage="Microsoft.ML.Data.MLImage.Tag" />
254+
<MemberType>Property</MemberType>
255+
<AssemblyInfo>
256+
<AssemblyName>Microsoft.ML.ImageAnalytics</AssemblyName>
257+
<AssemblyVersion>1.0.0.0</AssemblyVersion>
258+
</AssemblyInfo>
259+
<ReturnValue>
260+
<ReturnType>System.String</ReturnType>
261+
</ReturnValue>
262+
<Docs>
263+
<summary>
264+
Gets or sets the image tag.
265+
</summary>
266+
<value>To be added.</value>
267+
<remarks>To be added.</remarks>
268+
</Docs>
269+
</Member>
270+
<Member MemberName="Width">
271+
<MemberSignature Language="C#" Value="public int Width { get; }" />
272+
<MemberSignature Language="ILAsm" Value=".property instance int32 Width" />
273+
<MemberSignature Language="DocId" Value="P:Microsoft.ML.Data.MLImage.Width" />
274+
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Width As Integer" />
275+
<MemberSignature Language="F#" Value="member this.Width : int" Usage="Microsoft.ML.Data.MLImage.Width" />
276+
<MemberType>Property</MemberType>
277+
<AssemblyInfo>
278+
<AssemblyName>Microsoft.ML.ImageAnalytics</AssemblyName>
279+
<AssemblyVersion>1.0.0.0</AssemblyVersion>
280+
</AssemblyInfo>
281+
<ReturnValue>
282+
<ReturnType>System.Int32</ReturnType>
283+
</ReturnValue>
284+
<Docs>
285+
<summary>
286+
Gets the image width in pixels.
287+
</summary>
288+
<value>To be added.</value>
289+
<remarks>To be added.</remarks>
290+
</Docs>
291+
</Member>
292+
</Members>
293+
</Type>

0 commit comments

Comments
 (0)