-
Notifications
You must be signed in to change notification settings - Fork 43
Update namespace descriptions. #90
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.
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
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,10 @@ | ||
| <Namespace Name="Microsoft.ML.Calibrators"> | ||
| <Docs> | ||
| <summary> | ||
| Namespace containing estimators and transformers that take as input the output scores of binary classifiers, | ||
| and <a href="https://en.wikipedia.org/wiki/Probabilistic_classification#Probability_calibration">calibrate</a> them to produce a probability distribution. | ||
| Namespace containing components for binary classification <a href="https://en.wikipedia.org/wiki/Probabilistic_classification#Probability_calibration">calibration</a>. | ||
| </summary> | ||
| <remarks> | ||
| These components calculate probabilities from scores, for binary classifiers. | ||
| </remarks> | ||
| </Docs> | ||
| </Namespace> |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,7 @@ | ||
| <Namespace Name="Microsoft.ML.Data"> | ||
| <Docs> | ||
| <summary>Namespace containing data loading, data definition and data saving capabilities.</summary> | ||
| <summary> | ||
| Namespace containing data loading and saving, data schema definitions, and model training metrics components. | ||
| </summary> | ||
| </Docs> | ||
| </Namespace> |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,7 @@ | ||
| <Namespace Name="Microsoft.ML.Runtime"> | ||
| <Docs> | ||
| <summary>To be added.</summary> | ||
| <remarks>To be added.</remarks> | ||
| <summary> | ||
| Namespace containing types needed by the ML.NET runtime. | ||
| </summary> | ||
| </Docs> | ||
| </Namespace> |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,10 @@ | ||
| <Namespace Name="Microsoft.ML.SamplesUtils"> | ||
| <Docs> | ||
| <summary> | ||
| Namespace containing utilities to download and featurize datasets for the API reference samples. | ||
| It is part of the Microsoft.ML.SampleUtils nuget package. | ||
| Namespace containing utilities to download and featurize datasets for the API reference samples. | ||
| </summary> | ||
| <remarks> | ||
| Included in the Microsoft.ML.SampleUtils nuget package. | ||
| </remarks> | ||
| </Docs> | ||
| </Namespace> | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,5 @@ | ||
| <Namespace Name="Microsoft.ML.Trainers.FastTree"> | ||
| <Docs> | ||
| <summary>Namespace containing estimators, model parameters and other utilities related to the Fast Tree group of trainers.</summary> | ||
| <summary>Namespace containing trainers, model parameters, and utilities for Fast Tree algorithms.</summary> | ||
| </Docs> | ||
| </Namespace> |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,10 @@ | ||
| <Namespace Name="Microsoft.ML.Trainers.LightGbm"> | ||
| <Docs> | ||
| <summary>Namespace containing the various <a href="https://lightgbm.readthedocs.io/en/latest/">LightGBM</a> trainers. | ||
| This namespace is contained in the <a href="https://www.nuget.org/packages/Microsoft.ML.LightGBM/">Microsoft.ML.LightGBM</a> nuget package. | ||
| <summary> | ||
| Namespace containing trainers, model parameters, and utilities for <a href="https://lightgbm.readthedocs.io/en/latest/">LightGBM</a> algorithms. | ||
| </summary> | ||
| <remarks> | ||
| Included in the Microsoft.ML.LightGbm nuget package. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
should it link? |
||
| </remarks> | ||
| </Docs> | ||
| </Namespace> | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,7 @@ | ||
| <Namespace Name="Microsoft.ML.Trainers.Recommender"> | ||
| <Docs> | ||
| <summary> | ||
| Namespace containing estimators and transformers to perform <a href="https://en.wikipedia.org/wiki/Recommender_system">recommendation</a>. | ||
| Namespace containing trainers, model parameters, and utilities for <a href="https://en.wikipedia.org/wiki/Recommender_system">recommendation</a>. | ||
| </summary> | ||
| </Docs> | ||
| </Namespace> |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,7 @@ | ||
| <Namespace Name="Microsoft.ML.Trainers"> | ||
| <Docs> | ||
| <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 | ||
| machine learning model. | ||
| <summary> | ||
| Namespace containing trainers, model parameters, and utilities. | ||
| </summary> | ||
| </Docs> | ||
| </Namespace> |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,10 @@ | ||
| <Namespace Name="Microsoft.ML.Transforms.Image"> | ||
| <Docs> | ||
| <summary> | ||
| Namespace containing image loading and <a href="https://docs.microsoft.com/en-us/dotnet/machine-learning/resources/glossary#transform">transformation</a> capabilities. | ||
| It is contained in the <a href="https://www.nuget.org/packages/Microsoft.ML.ImageAnalytics/">Microsoft.ML.ImageAnalytics nuget package.</a> | ||
| Namespace containing image loading and transformation components. | ||
| </summary> | ||
| <remarks> | ||
| Contained in the Microsoft.ML.ImageAnalytics nuget package. | ||
| </remarks> | ||
| </Docs> | ||
| </Namespace> |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,7 @@ | ||
| <Namespace Name="Microsoft.ML.Transforms.Onnx"> | ||
| <Docs> | ||
| <summary>To be added.</summary> | ||
| <remarks>To be added.</remarks> | ||
| <summary> | ||
| Namespace containing <a href="https://onnx.ai/">ONNX</a> model loading and transformation components. | ||
| </summary> | ||
| </Docs> | ||
| </Namespace> |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,8 +1,7 @@ | ||
| <Namespace Name="Microsoft.ML.Transforms.TensorFlow"> | ||
| <Docs> | ||
| <summary> | ||
| The namespace containing the data transformations wrapping <a. href="https://www.tensorflow.org/">tensorflow</a.> | ||
| so it can be used as an estimator in ML.NET. | ||
| Namespace containing <a href="https://www.tensorflow.org/">tensorflow</a> model loading and transformation components. | ||
| </summary> | ||
| </Docs> | ||
| </Namespace> |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,7 @@ | ||
| <Namespace Name="Microsoft.ML.Transforms.Text"> | ||
| <Docs> | ||
| <summary>The namespace containing the various data transformations for text datasets.</summary> | ||
| <summary> | ||
| Namespace containing text data transformation components. | ||
| </summary> | ||
| </Docs> | ||
| </Namespace> |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,7 @@ | ||
| <Namespace Name="Microsoft.ML.Transforms.TimeSeries"> | ||
| <Docs> | ||
| <summary>A set of time series transfomer, estimator and their utilities, | ||
| used for <a href="https://docs.microsoft.com/en-us/dotnet/machine-learning/resources/tasks#anomaly-detection"> anomaly detection.</a> | ||
| <summary> | ||
| Namespace containing time-series data transformation components. | ||
| </summary> | ||
| </Docs> | ||
| </Namespace> |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,7 @@ | ||
| <Namespace Name="Microsoft.ML.Transforms"> | ||
| <Docs> | ||
| <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>. | ||
| <summary> | ||
| Namespace containing <a href="https://docs.microsoft.com/en-us/dotnet/machine-learning/resources/transforms">data transformation</a> components. | ||
| </summary> | ||
| </Docs> | ||
| </Namespace> |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,7 @@ | ||
| <Namespace Name="Microsoft.ML"> | ||
| <Docs> | ||
| <summary>The main namespace for <a href="https://docs.microsoft.com/en-us/dotnet/machine-learning/">ML.NET</a></summary> | ||
| <summary> | ||
| The main namespace for <a href="https://docs.microsoft.com/en-us/dotnet/machine-learning/">ML.NET</a>. Contains application and operation contexts, transformer and trainer catalogs, and components for data view processing. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
should it link? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We decided not to link |
||
| </summary> | ||
| </Docs> | ||
| </Namespace> | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
link to: https://www.nuget.org/packages/Microsoft.ML.SampleUtils