Skip to content

Commit 04fc061

Browse files
sfilipiJRAlexander
sfilipi
authored and
JRAlexander
committed
updating the filter and the namespace descriptions for ML.Net (dotnet#76)
* updating the filter and the namespace descriptions for ML.Net * Shahab's comments * John's comments * Addressing Luis' comments
1 parent 2bbe2f7 commit 04fc061

11 files changed

+48
-162
lines changed

‎dotnet/xml/_filter.xml‎

Lines changed: 24 additions & 142 deletions
Original file line numberDiff line numberDiff line change
@@ -1,152 +1,34 @@
11
<?xml version="1.0" encoding="utf-8"?>
22
<filter>
3-
<apiFilter apply="true">
4-
<namespaceFilter name="LotusIR">
5-
<typeFilter name="*" expose="false" />
6-
</namespaceFilter>
7-
<namespaceFilter name="Microsoft.ML.Runtime">
8-
<typeFilter name="*" expose="false" />
9-
<typeFilter name="CalibratorTrainer" expose="true" />
10-
<typeFilter name="ClassificationLossFunction" expose="true" />
11-
<typeFilter name="ComponentKind" expose="true" />
12-
<typeFilter name="ComponentSerializer" expose="true" />
13-
<typeFilter name="CustomStopWordsRemover" expose="true" />
14-
<typeFilter name="EarlyStoppingCriterion" expose="true" />
15-
<typeFilter name="EntryPointTrainerOutput" expose="true" />
16-
<typeFilter name="EntryPointTransformOutput" expose="true" />
17-
<typeFilter name="Experiment" expose="true" />
18-
<typeFilter name="ExperimentSerializer" expose="true" />
19-
<typeFilter name="ExperimentUtils" expose="true" />
20-
<typeFilter name="FastTreeBinaryClassificationFastTreeTrainer" expose="true" />
21-
<typeFilter name="FastTreeRankingFastTreeTrainer" expose="true" />
22-
<typeFilter name="FastTreeRegressionFastTreeTrainer" expose="true" />
23-
<typeFilter name="FastTreeTrainer" expose="true" />
24-
<typeFilter name="FastTreeTweedieRegressionFastTreeTrainer" expose="true" />
25-
<typeFilter name="FixedPlattCalibratorCalibratorTrainer" expose="true" />
26-
<typeFilter name="GLEarlyStoppingCriterion" expose="true" />
27-
<typeFilter name="IPredictor" expose="true" />
28-
<typeFilter name="ITrainer" expose="true" />
29-
<typeFilter name="TrainContext" expose="true" />
30-
<typeFilter name="TrainerInfo" expose="true" />
31-
<typeFilter name="HingeLossClassificationLossFunction" expose="true" />
32-
<typeFilter name="HingeLossSDCAClassificationLossFunction" expose="true" />
33-
<typeFilter name="LogLossClassificationLossFunction" expose="true" />
34-
<typeFilter name="LogLossSDCAClassificationLossFunction" expose="true" />
35-
<typeFilter name="LPEarlyStoppingCriterion" expose="true" />
36-
<typeFilter name="NaiveCalibratorCalibratorTrainer" expose="true" />
37-
<typeFilter name="NgramExtractor" expose="true" />
38-
<typeFilter name="NGramHashNgramExtractor" expose="true" />
39-
<typeFilter name="NGramNgramExtractor" expose="true" />
40-
<typeFilter name="ParallelTraining" expose="true" />
41-
<typeFilter name="PavCalibratorCalibratorTrainer" expose="true" />
42-
<typeFilter name="PlattCalibratorCalibratorTrainer" expose="true" />
43-
<typeFilter name="PoissonLossRegressionLossFunction" expose="true" />
44-
<typeFilter name="PQEarlyStoppingCriterion" expose="true" />
45-
<typeFilter name="PredefinedStopWordsRemover" expose="true" />
46-
<typeFilter name="RegressionLossFunction" expose="true" />
47-
<typeFilter name="SDCAClassificationLossFunction" expose="true" />
48-
<typeFilter name="SDCARegressionLossFunction" expose="true" />
49-
<typeFilter name="SingleParallelTraining" expose="true" />
50-
<typeFilter name="SmoothedHingeLossClassificationLossFunction" expose="true" />
51-
<typeFilter name="SmoothedHingeLossSDCAClassificationLossFunction" expose="true" />
52-
<typeFilter name="SquaredLossRegressionLossFunction" expose="true" />
53-
<typeFilter name="SquaredLossSDCARegressionLossFunction" expose="true" />
54-
<typeFilter name="StopWordsRemover" expose="true" />
55-
<typeFilter name="TREarlyStoppingCriterion" expose="true" />
56-
<typeFilter name="TweedieLossRegressionLossFunction" expose="true" />
57-
<typeFilter name="UPEarlyStoppingCriterion" expose="true" />
58-
</namespaceFilter>
59-
<namespaceFilter name="Microsoft.ML.Runtime.Api">
60-
<typeFilter name="*" expose="false" />
61-
<typeFilter name="ColumnAttribute" expose="true" />
62-
<typeFilter name="ColumnNameAttribute" expose="true" />
63-
</namespaceFilter>
64-
<namespaceFilter name="Microsoft.ML.Runtime.Command">
65-
<typeFilter name="*" expose="false" />
66-
</namespaceFilter>
67-
<namespaceFilter name="Microsoft.ML.Runtime.CommandLine">
68-
<typeFilter name="*" expose="false" />
69-
</namespaceFilter>
70-
<namespaceFilter name="Microsoft.ML.Runtime.Data.Conversion">
71-
<typeFilter name="*" expose="false" />
72-
</namespaceFilter>
73-
<namespaceFilter name="Microsoft.ML.Runtime.Data.IO">
74-
<typeFilter name="*" expose="false" />
75-
</namespaceFilter>
76-
<namespaceFilter name="Microsoft.ML.Runtime.Data.IO.Zlib">
77-
<typeFilter name="*" expose="false" />
78-
</namespaceFilter>
79-
<namespaceFilter name="Microsoft.ML.Runtime.DataPipe">
80-
<typeFilter name="*" expose="false" />
81-
</namespaceFilter>
82-
<namespaceFilter name="Microsoft.ML.Runtime.EntryPoints">
83-
<typeFilter name="*" expose="false" />
84-
</namespaceFilter>
85-
<namespaceFilter name="Microsoft.ML.Runtime.EntryPoints.CodeGen">
86-
<typeFilter name="*" expose="false" />
87-
</namespaceFilter>
88-
<namespaceFilter name="Microsoft.ML.Runtime.EntryPoints.JsonUtils">
89-
<typeFilter name="*" expose="false" />
90-
</namespaceFilter>
91-
<namespaceFilter name="Microsoft.ML.Runtime.FastTree">
92-
<typeFilter name="*" expose="false" />
93-
</namespaceFilter>
94-
<namespaceFilter name="Microsoft.ML.Runtime.FastTree.Internal">
95-
<typeFilter name="*" expose="false" />
96-
</namespaceFilter>
97-
<namespaceFilter name="Microsoft.ML.Runtime.Internal.Calibration">
98-
<typeFilter name="*" expose="false" />
99-
</namespaceFilter>
100-
<namespaceFilter name="Microsoft.ML.Runtime.Internal.CpuMath">
101-
<typeFilter name="*" expose="false" />
102-
</namespaceFilter>
103-
<namespaceFilter name="Microsoft.ML.Runtime.Internal.Internallearn">
104-
<typeFilter name="*" expose="false" />
105-
</namespaceFilter>
106-
<namespaceFilter name="Microsoft.ML.Runtime.Internal.Internallearn.ResultProcessor">
107-
<typeFilter name="*" expose="false" />
108-
</namespaceFilter>
109-
<namespaceFilter name="Microsoft.ML.Runtime.Internal.IO">
110-
<typeFilter name="*" expose="false" />
111-
</namespaceFilter>
112-
<namespaceFilter name="Microsoft.ML.Runtime.Internal.Tools">
113-
<typeFilter name="*" expose="false" />
114-
</namespaceFilter>
115-
<namespaceFilter name="Microsoft.ML.Runtime.Internal.Utilities">
116-
<typeFilter name="*" expose="false" />
117-
</namespaceFilter>
118-
<namespaceFilter name="Microsoft.ML.Runtime.Model">
119-
<typeFilter name="*" expose="false" />
120-
</namespaceFilter>
121-
<namespaceFilter name="Microsoft.ML.Runtime.Model.Onnx">
122-
<typeFilter name="*" expose="false" />
123-
</namespaceFilter>
124-
<namespaceFilter name="Microsoft.ML.Runtime.Model.Pfa">
125-
<typeFilter name="*" expose="false" />
126-
</namespaceFilter>
127-
<namespaceFilter name="Microsoft.ML.Runtime.Numeric">
128-
<typeFilter name="*" expose="false" />
3+
<attributeFilter apply="true">
4+
<!-- It appears that if we have an internal Attribute class, and we use that attribute on a public member, the attributes are showing up in our docs.
5+
Filtering all attributes that we don't want displayed explicitely here. -->
6+
<namespaceFilter name="Microsoft.ML">
7+
<typeFilter name="LoadableClassAttribute" expose="false" />
8+
<typeFilter name="*" expose="true" />
1299
</namespaceFilter>
130-
<namespaceFilter name="Microsoft.ML.Runtime.PipelineInference">
131-
<typeFilter name="*" expose="false" />
10+
<namespaceFilter name="Microsoft.ML.CommandLine">
11+
<typeFilter name="*" expose="false" /><!-- EnumValueDisplayAttribute. -->
13212
</namespaceFilter>
133-
<namespaceFilter name="Microsoft.ML.Runtime.Sweeper">
13+
<namespaceFilter name="Microsoft.ML.Internal.Internallearn">
13414
<typeFilter name="*" expose="false" />
15+
<!-- TGUI-->
13516
</namespaceFilter>
136-
<namespaceFilter name="Microsoft.ML.Runtime.Sweeper.Algorithms">
137-
<typeFilter name="*" expose="false" />
17+
<namespaceFilter name="Microsoft.ML.Data">
18+
<typeFilter name="CursorChannelAttribute" expose="false" />
19+
<typeFilter name="*" expose="true" /><!-- SchemaDefinition attributes, LoadColumn-->
13820
</namespaceFilter>
139-
<namespaceFilter name="Microsoft.ML.Runtime.TextAnalytics">
140-
<typeFilter name="*" expose="false" />
21+
<namespaceFilter name="Microsoft.ML.EntryPoints">
22+
<typeFilter name="*" expose="false" /><!-- Attributes in ModuleArgs.cs-->
14123
</namespaceFilter>
142-
<namespaceFilter name="Microsoft.ML.Runtime.Tools">
143-
<typeFilter name="*" expose="false" />
24+
<namespaceFilter name="Microsoft.ML.Internal.CpuMath.Core">
25+
<typeFilter name="*" expose="false" /> <!-- BestFriends and WantsToBeBestFriend-->
14426
</namespaceFilter>
145-
<namespaceFilter name="Microsoft.ML.Runtime.Training">
146-
<typeFilter name="*" expose="false" />
147-
</namespaceFilter>
148-
<namespaceFilter name="Microsoft.ML.Runtime.UniversalModelFormat.Onnx">
149-
<typeFilter name="*" expose="false" />
27+
<namespaceFilter name="Microsoft.ML.Transforms.TensorFlow">
28+
<typeFilter name="MonoPInvokeCallbackAttribute" expose="false" />
29+
<typeFilter name="*" expose="true" />
15030
</namespaceFilter>
151-
</apiFilter>
152-
</filter>
31+
32+
</attributeFilter>
33+
34+
</filter>

‎dotnet/xml/ns-Microsoft.Data.DataView.xml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="Microsoft.Data.DataView">
22
<Docs>
3-
<summary>To be added.</summary>
4-
<remarks>To be added.</remarks>
3+
<summary>Namespace containing types related to the <a href="https://github.com/dotnet/machinelearning/blob/master/docs/code/IDataViewDesignPrinciples.md">IDataView</a> system, which is a set of interfaces and components that provide efficient,
4+
compositional processing of schematized data for machine learning and advanced analytics applications. </summary>
55
</Docs>
66
</Namespace>

‎dotnet/xml/ns-Microsoft.ML.Calibrator.xml‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
<Namespace Name="Microsoft.ML.Calibrator">
22
<Docs>
3-
<summary>To be added.</summary>
4-
<remarks>To be added.</remarks>
3+
<summary>Namespace containing the various calibrator estimators that help interpret binary classification scores as probabilities.</summary>
54
</Docs>
65
</Namespace>

‎dotnet/xml/ns-Microsoft.ML.Data.xml‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
<Namespace Name="Microsoft.ML.Data">
22
<Docs>
3-
<summary>To be added.</summary>
4-
<remarks>To be added.</remarks>
3+
<summary>Namespace containing data loading, data definition and data saving capabilities.</summary>
54
</Docs>
65
</Namespace>

‎dotnet/xml/ns-Microsoft.ML.ImageAnalytics.xml‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
<Namespace Name="Microsoft.ML.ImageAnalytics">
22
<Docs>
3-
<summary>To be added.</summary>
4-
<remarks>To be added.</remarks>
3+
<summary>Namespace containing image loading and <a href="https://docs.microsoft.com/en-us/dotnet/machine-learning/resources/glossary#transform">transformation</a> capabilites.
4+
It is contained in the <a href="https://www.nuget.org/packages/Microsoft.ML.ImageAnalytics/">Microsoft.ML.ImageAnalytics nuget package.</a>
5+
</summary>
56
</Docs>
67
</Namespace>

‎dotnet/xml/ns-Microsoft.ML.LightGBM.xml‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
<Namespace Name="Microsoft.ML.LightGBM">
22
<Docs>
3-
<summary>To be added.</summary>
4-
<remarks>To be added.</remarks>
3+
<summary>Namespace containing the various <a href="https://lightgbm.readthedocs.io/en/latest/">LightGBM</a> trainers.
4+
This namespace is contained in the <a href="https://www.nuget.org/packages/Microsoft.ML.LightGBM/">Microsoft.ML.LightGBM</a> nuget package.
5+
</summary>
56
</Docs>
67
</Namespace>

‎dotnet/xml/ns-Microsoft.ML.SamplesUtils.xml‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
<Namespace Name="Microsoft.ML.SamplesUtils">
22
<Docs>
3-
<summary>To be added.</summary>
4-
<remarks>To be added.</remarks>
3+
<summary>
4+
Namespace containing utilities to download and featurize datasets for the API reference samples.
5+
It is part of the Microsoft.ML.SampleUtils nuget package.
6+
</summary>
57
</Docs>
68
</Namespace>

‎dotnet/xml/ns-Microsoft.ML.StaticPipe.xml‎

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
<Namespace Name="Microsoft.ML.StaticPipe">
22
<Docs>
3-
<summary>To be added.</summary>
4-
<remarks>To be added.</remarks>
3+
<summary>
4+
Namespace containing the experimental strongly typed API of ML.NET. For more you can see the
5+
<a href="https://github.com/dotnet/machinelearning/blob/master/docs/code/experimental/MlNetCookBookStaticApi.md">ML.NET Cookbook with Static API examples.</a>.
6+
</summary>
57
</Docs>
68
</Namespace>

‎dotnet/xml/ns-Microsoft.ML.Trainers.xml‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
<Namespace Name="Microsoft.ML.Trainers">
22
<Docs>
3-
<summary>To be added.</summary>
4-
<remarks>To be added.</remarks>
3+
<summary>The namespace containing the algorithms used for <a href="https://docs.microsoft.com/en-us/dotnet/machine-learning/resources/glossary#training">training</a> a
4+
machine learning model.
5+
</summary>
56
</Docs>
67
</Namespace>

‎dotnet/xml/ns-Microsoft.ML.Transforms.xml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<Namespace Name="Microsoft.ML.Transforms">
22
<Docs>
3-
<summary>To be added.</summary>
4-
<remarks>To be added.</remarks>
3+
<summary>The namespace containing the various <a href="https://docs.microsoft.com/en-us/dotnet/machine-learning/resources/transforms">data transformations for text and numerical datasets.</a>.
4+
</summary>
55
</Docs>
66
</Namespace>

0 commit comments

Comments
 (0)