Skip to content

Conversation

@natke
Copy link
Contributor

@natke natke commented Apr 24, 2019

Update namespace descriptions for the ML.NET API documentation

Preview links:
https://review.docs.microsoft.com/en-us/dotnet/api/microsoft.ml?branch=pr-en-us-90&view=ml-dotnet
https://review.docs.microsoft.com/en-us/dotnet/api/microsoft.ml.data?branch=pr-en-us-90&view=ml-dotnet
https://review.docs.microsoft.com/en-us/dotnet/api/microsoft.ml.trainers?branch=pr-en-us-90&view=ml-dotnet
https://review.docs.microsoft.com/en-us/dotnet/api/microsoft.ml.trainers.fasttree?branch=pr-en-us-90&view=ml-dotnet
https://review.docs.microsoft.com/en-us/dotnet/api/microsoft.ml.trainers.lightgbm?branch=pr-en-us-90&view=ml-dotnet
https://review.docs.microsoft.com/en-us/dotnet/api/microsoft.ml.trainers.recommender?branch=pr-en-us-90&view=ml-dotnet-preview&viewFallbackFrom=ml-dotnet
https://review.docs.microsoft.com/en-us/dotnet/api/microsoft.ml.transforms?branch=pr-en-us-90&view=ml-dotnet
https://review.docs.microsoft.com/en-us/dotnet/api/microsoft.ml.transforms.text?branch=pr-en-us-90&view=ml-dotnet
https://review.docs.microsoft.com/en-us/dotnet/api/microsoft.ml.transforms.image?branch=pr-en-us-90&view=ml-dotnet
https://review.docs.microsoft.com/en-us/dotnet/api/microsoft.ml.transforms.onnx?branch=pr-en-us-90&view=ml-dotnet-preview&viewFallbackFrom=ml-dotnet
https://review.docs.microsoft.com/en-us/dotnet/api/microsoft.ml.transforms.tensorflow?branch=pr-en-us-90&view=ml-dotnet-preview&viewFallbackFrom=ml-dotnet
https://review.docs.microsoft.com/en-us/dotnet/api/microsoft.ml.transforms.timeseries?branch=pr-en-us-90&view=ml-dotnet-preview&viewFallbackFrom=ml-dotnet
https://review.docs.microsoft.com/en-us/dotnet/api/microsoft.ml.samplesutils?branch=pr-en-us-90&view=ml-dotnet-preview&viewFallbackFrom=ml-dotnet
https://review.docs.microsoft.com/en-us/dotnet/api/microsoft.ml.staticpipe?branch=pr-en-us-90&view=ml-dotnet-preview&viewFallbackFrom=ml-dotnet
https://review.docs.microsoft.com/en-us/dotnet/api/microsoft.ml.calibrators?branch=pr-en-us-90&view=ml-dotnet
https://review.docs.microsoft.com/en-us/dotnet/api/microsoft.ml.runtime?branch=pr-en-us-90&view=ml-dotnet

@natke natke requested review from sfilipi and shmoradims April 24, 2019 20:41
<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 transforming components.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

loading and transforming [](start = 33, length = 24)

loading and transformation

Copy link

@shmoradims shmoradims left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:shipit:

<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Namespace containing advanced types that support ML.NET.</summary>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Namespace containing advanced types that support ML.NET [](start = 13, length = 55)

it is mostly things related to IHost, IChannel: logging, setting the seed.

Maybe Namespace containing types needed by the ML.NET runtime.

Advanced types makes me thing advanced ML things.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That sounds good to me. @shmoradims ?

Namespace containing utilities to download and featurize datasets for the API reference samples.
</summary>
<remarks>
Included in the Microsoft.ML.SampleUtils nuget package.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Microsoft.ML.SampleUtils [](start = 20, length = 24)

link to: https://www.nuget.org/packages/Microsoft.ML.SampleUtils

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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Microsoft.ML.LightGbm [](start = 22, length = 21)

should it link?

Copy link
Member

@sfilipi sfilipi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:shipit:

<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>
Namespace containing ONNX model loading and transformation components.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ONNX [](start = 27, length = 4)

link https://onnx.ai/

<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 used for <a href="https://docs.microsoft.com/en-us/dotnet/machine-learning/resources/tasks#anomaly-detection">anomaly detection.</a>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

used for anomaly detection. [](start = 71, length = 133)

let's remove this. I think they can also do just time series analysis with them.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ok

<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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

data view [](start = 207, length = 9)

should it link?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We decided not to link

@natke natke merged commit 4510784 into dotnet:master Apr 24, 2019
@natke natke deleted the namespace-descriptions branch April 24, 2019 21:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants