Skip to content

Commit 5942381

Browse files
author
VSC-Service-Account
committed
CI Update
1 parent 5ae3f8b commit 5942381

File tree

61 files changed

+5109
-2893
lines changed

Some content is hidden

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

61 files changed

+5109
-2893
lines changed

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

Lines changed: 2293 additions & 0 deletions
Large diffs are not rendered by default.

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

Lines changed: 45 additions & 99 deletions
Large diffs are not rendered by default.

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,8 +47,10 @@
4747
<Parameter Name="other" Type="Microsoft.ML.Data.DataViewType" />
4848
</Parameters>
4949
<Docs>
50-
<param name="other">To be added.</param>
51-
<summary>To be added.</summary>
50+
<param name="other">Another <see cref="T:Microsoft.ML.Data.DataViewType" /> to be compared with <see langword="this" />.</param>
51+
<summary>
52+
Return <see langword="true" /> if <see langword="this" /> is equivalent to <paramref name="other" /> and <see langword="false" /> otherwise.
53+
</summary>
5254
<returns>To be added.</returns>
5355
<remarks>To be added.</remarks>
5456
</Docs>

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

Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
<Type Name="DataViewTypeAttribute" FullName="Microsoft.ML.Data.DataViewTypeAttribute">
2+
<TypeSignature Language="C#" Value="public abstract class DataViewTypeAttribute : Attribute, IEquatable&lt;Microsoft.ML.Data.DataViewTypeAttribute&gt;" />
3+
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit DataViewTypeAttribute extends System.Attribute implements class System.IEquatable`1&lt;class Microsoft.ML.Data.DataViewTypeAttribute&gt;" />
4+
<TypeSignature Language="DocId" Value="T:Microsoft.ML.Data.DataViewTypeAttribute" />
5+
<TypeSignature Language="VB.NET" Value="Public MustInherit Class DataViewTypeAttribute&#xA;Inherits Attribute&#xA;Implements IEquatable(Of DataViewTypeAttribute)" />
6+
<TypeSignature Language="F#" Value="type DataViewTypeAttribute = class&#xA; inherit Attribute&#xA; interface IEquatable&lt;DataViewTypeAttribute&gt;" />
7+
<AssemblyInfo>
8+
<AssemblyName>Microsoft.ML.DataView</AssemblyName>
9+
<AssemblyVersion>1.0.0.0</AssemblyVersion>
10+
</AssemblyInfo>
11+
<Base>
12+
<BaseTypeName>System.Attribute</BaseTypeName>
13+
</Base>
14+
<Interfaces>
15+
<Interface>
16+
<InterfaceName>System.IEquatable&lt;Microsoft.ML.Data.DataViewTypeAttribute&gt;</InterfaceName>
17+
</Interface>
18+
</Interfaces>
19+
<Attributes>
20+
<Attribute>
21+
<AttributeName>System.AttributeUsage(System.AttributeTargets.Property | System.AttributeTargets.Field, AllowMultiple=false, Inherited=true)</AttributeName>
22+
</Attribute>
23+
</Attributes>
24+
<Docs>
25+
<summary>
26+
<see cref="T:Microsoft.ML.Data.DataViewTypeAttribute" /> should be used to decorated class properties and fields, if that class' instances will be loaded as ML.NET <see cref="T:Microsoft.ML.IDataView" />.
27+
The function <see cref="M:Microsoft.ML.Data.DataViewTypeAttribute.Register" /> will be called to register a <see cref="T:Microsoft.ML.Data.DataViewType" /> for a <see cref="T:System.Type" /> with its <see cref="T:System.Attribute" />s.
28+
Whenever a value typed to the registered <see cref="T:System.Type" /> and its <see cref="T:System.Attribute" />s, that value's type (i.e., a <see cref="P:Microsoft.ML.DataViewSchema.Column.Type" />)
29+
in <see cref="T:Microsoft.ML.IDataView" /> would be the associated <see cref="T:Microsoft.ML.Data.DataViewType" />.
30+
</summary>
31+
<remarks>To be added.</remarks>
32+
</Docs>
33+
<Members>
34+
<Member MemberName=".ctor">
35+
<MemberSignature Language="C#" Value="protected DataViewTypeAttribute ();" />
36+
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
37+
<MemberSignature Language="DocId" Value="M:Microsoft.ML.Data.DataViewTypeAttribute.#ctor" />
38+
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
39+
<MemberType>Constructor</MemberType>
40+
<AssemblyInfo>
41+
<AssemblyName>Microsoft.ML.DataView</AssemblyName>
42+
<AssemblyVersion>1.0.0.0</AssemblyVersion>
43+
</AssemblyInfo>
44+
<Parameters />
45+
<Docs>
46+
<summary>To be added.</summary>
47+
<remarks>To be added.</remarks>
48+
</Docs>
49+
</Member>
50+
<Member MemberName="Equals">
51+
<MemberSignature Language="C#" Value="public abstract bool Equals (Microsoft.ML.Data.DataViewTypeAttribute other);" />
52+
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool Equals(class Microsoft.ML.Data.DataViewTypeAttribute other) cil managed" />
53+
<MemberSignature Language="DocId" Value="M:Microsoft.ML.Data.DataViewTypeAttribute.Equals(Microsoft.ML.Data.DataViewTypeAttribute)" />
54+
<MemberSignature Language="VB.NET" Value="Public MustOverride Function Equals (other As DataViewTypeAttribute) As Boolean" />
55+
<MemberSignature Language="F#" Value="override this.Equals : Microsoft.ML.Data.DataViewTypeAttribute -&gt; bool" Usage="dataViewTypeAttribute.Equals other" />
56+
<MemberType>Method</MemberType>
57+
<Implements>
58+
<InterfaceMember>M:System.IEquatable`1.Equals(`0)</InterfaceMember>
59+
</Implements>
60+
<AssemblyInfo>
61+
<AssemblyName>Microsoft.ML.DataView</AssemblyName>
62+
<AssemblyVersion>1.0.0.0</AssemblyVersion>
63+
</AssemblyInfo>
64+
<ReturnValue>
65+
<ReturnType>System.Boolean</ReturnType>
66+
</ReturnValue>
67+
<Parameters>
68+
<Parameter Name="other" Type="Microsoft.ML.Data.DataViewTypeAttribute" />
69+
</Parameters>
70+
<Docs>
71+
<param name="other">Another <see cref="T:Microsoft.ML.Data.DataViewTypeAttribute" /> to be compared with <see langword="this" />.</param>
72+
<summary>
73+
Return <see langword="true" /> if <see langword="this" /> is equivalent to <paramref name="other" /> and <see langword="false" /> otherwise.
74+
</summary>
75+
<returns>To be added.</returns>
76+
<remarks>To be added.</remarks>
77+
</Docs>
78+
</Member>
79+
<Member MemberName="Register">
80+
<MemberSignature Language="C#" Value="public abstract void Register ();" />
81+
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Register() cil managed" />
82+
<MemberSignature Language="DocId" Value="M:Microsoft.ML.Data.DataViewTypeAttribute.Register" />
83+
<MemberSignature Language="VB.NET" Value="Public MustOverride Sub Register ()" />
84+
<MemberSignature Language="F#" Value="abstract member Register : unit -&gt; unit" Usage="dataViewTypeAttribute.Register " />
85+
<MemberType>Method</MemberType>
86+
<AssemblyInfo>
87+
<AssemblyName>Microsoft.ML.DataView</AssemblyName>
88+
<AssemblyVersion>1.0.0.0</AssemblyVersion>
89+
</AssemblyInfo>
90+
<ReturnValue>
91+
<ReturnType>System.Void</ReturnType>
92+
</ReturnValue>
93+
<Parameters />
94+
<Docs>
95+
<summary>
96+
A function implicitly invoked by ML.NET when processing a custom type. It binds a DataViewType to a custom type plus its attributes.
97+
</summary>
98+
<remarks>To be added.</remarks>
99+
</Docs>
100+
</Member>
101+
</Members>
102+
</Type>

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

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
<Type Name="DataViewTypeManager" FullName="Microsoft.ML.Data.DataViewTypeManager">
2+
<TypeSignature Language="C#" Value="public static class DataViewTypeManager" />
3+
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit DataViewTypeManager extends System.Object" />
4+
<TypeSignature Language="DocId" Value="T:Microsoft.ML.Data.DataViewTypeManager" />
5+
<TypeSignature Language="VB.NET" Value="Public Class DataViewTypeManager" />
6+
<TypeSignature Language="F#" Value="type DataViewTypeManager = class" />
7+
<AssemblyInfo>
8+
<AssemblyName>Microsoft.ML.Data</AssemblyName>
9+
<AssemblyVersion>1.0.0.0</AssemblyVersion>
10+
</AssemblyInfo>
11+
<Base>
12+
<BaseTypeName>System.Object</BaseTypeName>
13+
</Base>
14+
<Interfaces />
15+
<Docs>
16+
<summary>
17+
A singleton class for managing the map between ML.NET <see cref="T:Microsoft.ML.Data.DataViewType" /> and C# <see cref="T:System.Type" />.
18+
To support custom column type in <see cref="T:Microsoft.ML.IDataView" />, the column's underlying type (e.g., a C# class's type)
19+
should be registered with a class derived from <see cref="T:Microsoft.ML.Data.DataViewType" />.
20+
</summary>
21+
<remarks>To be added.</remarks>
22+
</Docs>
23+
<Members>
24+
<Member MemberName="Register">
25+
<MemberSignature Language="C#" Value="public static void Register (Microsoft.ML.Data.DataViewType dataViewType, Type type, System.Collections.Generic.IEnumerable&lt;Attribute&gt; typeAttributes = null);" />
26+
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void Register(class Microsoft.ML.Data.DataViewType dataViewType, class System.Type type, class System.Collections.Generic.IEnumerable`1&lt;class System.Attribute&gt; typeAttributes) cil managed" />
27+
<MemberSignature Language="DocId" Value="M:Microsoft.ML.Data.DataViewTypeManager.Register(Microsoft.ML.Data.DataViewType,System.Type,System.Collections.Generic.IEnumerable{System.Attribute})" />
28+
<MemberSignature Language="F#" Value="static member Register : Microsoft.ML.Data.DataViewType * Type * seq&lt;Attribute&gt; -&gt; unit" Usage="Microsoft.ML.Data.DataViewTypeManager.Register (dataViewType, type, typeAttributes)" />
29+
<MemberType>Method</MemberType>
30+
<AssemblyInfo>
31+
<AssemblyName>Microsoft.ML.Data</AssemblyName>
32+
<AssemblyVersion>1.0.0.0</AssemblyVersion>
33+
</AssemblyInfo>
34+
<ReturnValue>
35+
<ReturnType>System.Void</ReturnType>
36+
</ReturnValue>
37+
<Parameters>
38+
<Parameter Name="dataViewType" Type="Microsoft.ML.Data.DataViewType" />
39+
<Parameter Name="type" Type="System.Type" />
40+
<Parameter Name="typeAttributes" Type="System.Collections.Generic.IEnumerable&lt;System.Attribute&gt;" />
41+
</Parameters>
42+
<Docs>
43+
<param name="dataViewType">The corresponding type of <paramref name="type" /> in ML.NET's type system.</param>
44+
<param name="type">Native type in C#.</param>
45+
<param name="typeAttributes">The <see cref="T:System.Attribute" />s attached to <paramref name="type" />.</param>
46+
<summary>
47+
This function tells that <paramref name="dataViewType" /> should be representation of data in <paramref name="type" /> in
48+
ML.NET's type system. The registered <paramref name="type" /> must be a standard C# object's type.
49+
</summary>
50+
<remarks>To be added.</remarks>
51+
</Docs>
52+
</Member>
53+
</Members>
54+
</Type>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
<Parameters>
4040
<Parameter Name="paths" Type="System.String[]">
4141
<Attributes>
42-
<Attribute>
42+
<Attribute FrameworkAlternate="ml-dotnet">
4343
<AttributeName>System.ParamArray</AttributeName>
4444
</Attribute>
4545
</Attributes>

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

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -172,12 +172,16 @@
172172
</summary>
173173
<value>To be added.</value>
174174
<remarks>
175-
The log-loss metric, is computed as follows:
176-
LL = - (1/m) * sum( log(p[i]))
177-
where m is the number of instances in the test set.
178-
p[i] is the probability returned by the classifier if the instance belongs to the class,
175+
The log-loss metric is computed as $-\frac{1}{m} \sum_{i=1}^m \log(p_i)$,
176+
where $m$ is the number of instances in the test set.
177+
$p_i$ is the probability returned by the classifier if the instance belongs to the class,
179178
and 1 minus the probability returned by the classifier if the instance does not belong to the class.
180179
</remarks>
180+
<example>
181+
<format type="text/markdown"><![CDATA[
182+
[!code-csharp[LogLoss](~/../docs/samples/docs/samples/Microsoft.ML.Samples/Dynamic/Trainers/MulticlassClassification/LogLossPerClass.cs)]
183+
]]></format>
184+
</example>
181185
</Docs>
182186
</Member>
183187
<Member MemberName="TopKAccuracy">

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -79,6 +79,11 @@
7979
</summary>
8080
<returns>To be added.</returns>
8181
<remarks>To be added.</remarks>
82+
<example>
83+
<format type="text/markdown"><![CDATA[
84+
[!code-csharp[Load](~/../docs/samples/docs/samples/Microsoft.ML.Samples/Dynamic/DataOperations/LoadingText.cs)]
85+
]]></format>
86+
</example>
8287
</Docs>
8388
</Member>
8489
<Member MemberName="Microsoft.ML.ICanSaveModel.Save">

‎dotnet/xml/Microsoft.ML.Data/TransformerChain`1.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@
5656
<Parameters>
5757
<Parameter Name="transformers" Type="Microsoft.ML.ITransformer[]">
5858
<Attributes>
59-
<Attribute>
59+
<Attribute FrameworkAlternate="ml-dotnet">
6060
<AttributeName>System.ParamArray</AttributeName>
6161
</Attribute>
6262
</Attributes>

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@
8585
<Parameter Name="itemType" Type="Microsoft.ML.Data.PrimitiveDataViewType" />
8686
<Parameter Name="dimensions" Type="System.Int32[]">
8787
<Attributes>
88-
<Attribute>
88+
<Attribute FrameworkAlternate="ml-dotnet">
8989
<AttributeName>System.ParamArray</AttributeName>
9090
</Attribute>
9191
</Attributes>

0 commit comments

Comments
 (0)