Skip to content

Commit 4510784

Browse files
authored
Update namespace descriptions. (dotnet#90)
1 parent 9b02de6 commit 4510784

15 files changed

+41
-24
lines changed
Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
<Namespace Name="Microsoft.ML.Calibrators">
22
<Docs>
33
<summary>
4-
Namespace containing estimators and transformers that take as input the output scores of binary classifiers,
5-
and <a href="https://en.wikipedia.org/wiki/Probabilistic_classification#Probability_calibration">calibrate</a> them to produce a probability distribution.
4+
Namespace containing components for binary classification <a href="https://en.wikipedia.org/wiki/Probabilistic_classification#Probability_calibration">calibration</a>.
65
</summary>
6+
<remarks>
7+
These components calculate probabilities from scores, for binary classifiers.
8+
</remarks>
79
</Docs>
810
</Namespace>
Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
<Namespace Name="Microsoft.ML.Data">
22
<Docs>
3-
<summary>Namespace containing data loading, data definition and data saving capabilities.</summary>
3+
<summary>
4+
Namespace containing data loading and saving, data schema definitions, and model training metrics components.
5+
</summary>
46
</Docs>
57
</Namespace>
Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
<Namespace Name="Microsoft.ML.Runtime">
22
<Docs>
3-
<summary>To be added.</summary>
4-
<remarks>To be added.</remarks>
3+
<summary>
4+
Namespace containing types needed by the ML.NET runtime.
5+
</summary>
56
</Docs>
67
</Namespace>
Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
<Namespace Name="Microsoft.ML.SamplesUtils">
22
<Docs>
33
<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.
4+
Namespace containing utilities to download and featurize datasets for the API reference samples.
65
</summary>
6+
<remarks>
7+
Included in the Microsoft.ML.SampleUtils nuget package.
8+
</remarks>
79
</Docs>
810
</Namespace>
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<Namespace Name="Microsoft.ML.Trainers.FastTree">
22
<Docs>
3-
<summary>Namespace containing estimators, model parameters and other utilities related to the Fast Tree group of trainers.</summary>
3+
<summary>Namespace containing trainers, model parameters, and utilities for Fast Tree algorithms.</summary>
44
</Docs>
55
</Namespace>
Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,10 @@
11
<Namespace Name="Microsoft.ML.Trainers.LightGbm">
22
<Docs>
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.
3+
<summary>
4+
Namespace containing trainers, model parameters, and utilities for <a href="https://lightgbm.readthedocs.io/en/latest/">LightGBM</a> algorithms.
55
</summary>
6+
<remarks>
7+
Included in the Microsoft.ML.LightGbm nuget package.
8+
</remarks>
69
</Docs>
710
</Namespace>
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<Namespace Name="Microsoft.ML.Trainers.Recommender">
22
<Docs>
33
<summary>
4-
Namespace containing estimators and transformers to perform <a href="https://en.wikipedia.org/wiki/Recommender_system">recommendation</a>.
4+
Namespace containing trainers, model parameters, and utilities for <a href="https://en.wikipedia.org/wiki/Recommender_system">recommendation</a>.
55
</summary>
66
</Docs>
77
</Namespace>
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<Namespace Name="Microsoft.ML.Trainers">
22
<Docs>
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.
3+
<summary>
4+
Namespace containing trainers, model parameters, and utilities.
55
</summary>
66
</Docs>
77
</Namespace>
Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
<Namespace Name="Microsoft.ML.Transforms.Image">
22
<Docs>
33
<summary>
4-
Namespace containing image loading and <a href="https://docs.microsoft.com/en-us/dotnet/machine-learning/resources/glossary#transform">transformation</a> capabilities.
5-
It is contained in the <a href="https://www.nuget.org/packages/Microsoft.ML.ImageAnalytics/">Microsoft.ML.ImageAnalytics nuget package.</a>
4+
Namespace containing image loading and transformation components.
65
</summary>
6+
<remarks>
7+
Contained in the Microsoft.ML.ImageAnalytics nuget package.
8+
</remarks>
79
</Docs>
810
</Namespace>
Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
<Namespace Name="Microsoft.ML.Transforms.Onnx">
22
<Docs>
3-
<summary>To be added.</summary>
4-
<remarks>To be added.</remarks>
3+
<summary>
4+
Namespace containing <a href="https://onnx.ai/">ONNX</a> model loading and transformation components.
5+
</summary>
56
</Docs>
67
</Namespace>

0 commit comments

Comments
 (0)