Catalog documentation is not in sync with the code #3126
Labels
documentation
Related to documentation of ML.NET
P2
Priority of the issue for triage purpose: Needs to be fixed at some point.
question
Further information is requested
Issue
Our documentation hierarchy is not in sync with our code catalogs. For example, if you look at our Binary Classification Catalog:
https://docs.microsoft.com/en-us/dotnet/api/microsoft.ml.binaryclassificationcatalog?view=ml-dotnet
It contains a
Methods
andProperties
Links. If you drop down Properties, there is aTrainers
but that page is fairly empty:https://docs.microsoft.com/en-us/dotnet/api/microsoft.ml.binaryclassificationcatalog.trainers?view=ml-dotnet
If you look in other catalogs, you will eventually find the Binary Classification Trainers -- for example, LightGBM is located under LightGBM Extensions:
https://docs.microsoft.com/en-us/dotnet/api/microsoft.ml.lightgbmextensions.lightgbm?view=ml-dotnet
However, this does not match what a user would see in code as you can type:
mlContext.BinaryClassification.Trainers.LightGBM
The expectation is that a user should be able to navigate the API Catalog and view all of the functions under that catalog.
More info
It looks like the documentation tool is using the class name to determine the location of where the APIs are located:
machinelearning/src/Microsoft.ML.LightGbm/LightGbmCatalog.cs
Line 14 in 3663320
Maybe there is a way we can override what the tool is using through an attribute?
The text was updated successfully, but these errors were encountered: