Public API for KMeansPredictor #1739

najeeb-kazmi · 2018-11-27T19:35:48Z

…d internalize interfaces except ICanSaveModel

wschin · 2018-11-27T21:31:23Z

src/Microsoft.ML.KMeansClustering/KMeansModelParameters.cs

@@ -169,7 +172,7 @@ private void Map(in VBuffer<Float> src, Span<Float> distances)
            }
        }

-        public void SaveAsText(TextWriter writer, RoleMappedSchema schema)
+        void ICanSaveInTextFormat.SaveAsText(TextWriter writer, RoleMappedSchema schema)


Is it private?

wschin · 2018-11-27T21:32:32Z

src/Microsoft.ML.KMeansClustering/KMeansPlusPlusTrainer.cs

 {
    /// <include file='./doc.xml' path='doc/members/member[@name="KMeans++"]/*' />
-    public class KMeansPlusPlusTrainer : TrainerEstimatorBase<ClusteringPredictionTransformer<KMeansPredictor>, KMeansPredictor>
+    public class KMeansPlusPlusTrainer : TrainerEstimatorBase<ClusteringPredictionTransformer<KMeansModelParameters>, KMeansModelParameters>


Can Visual Studio retrieve the doc in xml? If not, we need to add enough information here.

src/Microsoft.ML.KMeansClustering/KMeansStatic.cs

src/Microsoft.ML.Legacy/AssemblyRegistration.cs

…aryPredictor.SaveCore

singlis · 2018-11-28T01:33:36Z

src/Microsoft.ML.StandardLearners/Standard/LinearPredictor.cs

@@ -185,7 +185,8 @@ protected LinearPredictor(IHostEnvironment env, string name, ModelLoadContext ct
                _weightsDenseLock = new object();
        }

-        protected override void SaveCore(ModelSaveContext ctx)
+        [BestFriend]
+        private protected override void SaveCore(ModelSaveContext ctx)


private [](start = 8, length = 7)

This is already a protected function on an internal class -- isn't that already hidden?

Sorry I misread - it is a public class and you are overriding SaveCore from PredictorBase which is protected. However, I dont quite follow how protected isnt hidden to begin with -- is this covering cases where classes derive from LinearPredictor? Also could LinearPredictor be internal?

In reply to: 236912196 [](ancestors = 236912196)

Hi @singlis , sorry just saw this now -- protected is absolutely not hidden. It won't show up in usage of instances, but will show up in docs and other contexts.

singlis · 2018-11-28T02:45:26Z

using Microsoft.ML.Trainers.Recommender;

can you sort the headers here...

Refers to: test/Microsoft.ML.StaticPipelineTesting/Training.cs:22 in 58aa330. [](commit_id = 58aa330, deletion_comment = False)

TomFinley · 2018-11-29T17:16:10Z

    public void SaveAsText(TextWriter writer, RoleMappedSchema schema)

Hi @najeeb-kazmi, thanks for doing this! The corresponding interface has been made internal, should we make these explicit implementations here and everywhere? It requires a little bit of work, but no more than you've already done for the SaveCore stuff.

Refers to: src/Microsoft.ML.FastTree/FastTree.cs:2968 in 073ff03. [](commit_id = 073ff03, deletion_comment = False)

src/Microsoft.ML.KMeansClustering/KMeansModelParameters.cs

TomFinley · 2018-12-04T18:37:57Z

src/Microsoft.ML.HalLearners/OlsLinearRegression.cs

@@ -296,7 +296,7 @@ private OlsLinearRegressionPredictor TrainCore(IChannel ch, FloatLabelCursor.Fac
            Double tss = 0; // total sum of squares
            using (var cursor = cursorFactory.Create())
            {
-                var lrPredictor = new LinearRegressionPredictor(Host, in weights, bias);
+                IValueMapper lrPredictor = new LinearRegressionPredictor(Host, in weights, bias);


IValueMapper lrPredictor [](start = 16, length = 24)

Good stuff

TomFinley

Thank you for dogin this @najeeb-kazmi !! This will lay the groundwork for lots more hiding in future.

docs/samples/Microsoft.ML.Samples/Dynamic/KMeans.cs

sfilipi · 2018-12-04T21:23:24Z

src/Microsoft.ML.KMeansClustering/KMeansModelParameters.cs


-namespace Microsoft.ML.Trainers.KMeans
+namespace Microsoft.ML.KMeansClustering


Microsoft.ML.KMeansClustering [](start = 10, length = 29)

i wonder if we want to put all predictors in something:

Microsoft.ML.ModelParameters.KMeansClustering

If the argument is that the namespace is "Trainers" and therefore only ITrainer implementors should live in that namespace, then I'd argue that we should not have "Trainers" in the namespace name, if you think it could cause confusion.

It would be very inconvenient to have predictors in a different namespace from their associated trainers (except in generalizable cases like linear predictors that can be produced by many things).

In reply to: 238843887 [](ancestors = 238843887)

Maybe Microsoft.ML.KMeans would be a better namespace, but let's not have one namespace every time we devise a new type that isn't a trainer, a predictor, or whatever. 😛

So both the trainer and predictor would be in Microsoft.ML.KMeansClustering. That is what I gather from @Zruty0 's description in #1699 .

On #1318 there was an explicit ask to put all the trainers inside Microsoft.ML.Trainers or appropriate namaspaces.

So if i read both those issues, the ModelParameters also go in the same namespace as the respective trainer; for this case Microsoft.ML.Trainers.Kmeans @TomFinley that sounds good?

That makes sense. I'll stick to the conventions in #1318 and revert the namespace to Microsoft.ML.Trainers.KMeans.

src/Microsoft.ML.KMeansClustering/KMeansModelParameters.cs

sfilipi

najeeb-kazmi added 2 commits November 26, 2018 17:01

Rename KMeansPredictor to KMeansModelParameters, rename namespace, an…

ab08535

…d internalize interfaces except ICanSaveModel

Internalizing SaveCore

cbb92f6

wschin reviewed Nov 27, 2018

View reviewed changes

src/Microsoft.ML.KMeansClustering/KMeansStatic.cs Outdated Show resolved Hide resolved

wschin reviewed Nov 27, 2018

View reviewed changes

src/Microsoft.ML.Legacy/AssemblyRegistration.cs Outdated Show resolved Hide resolved

Adding sample

bbf1dff

najeeb-kazmi requested review from sfilipi, TomFinley, Zruty0 and Ivanidzo4ka November 27, 2018 22:32

najeeb-kazmi added 3 commits November 27, 2018 15:44

BestFriend attribute for the correct method overridden by LightGbmBin…

28347a3

…aryPredictor.SaveCore

Making FastTree best friends with LightGBM

58aa330

Update core_ep-list.tsv

f8663e8

najeeb-kazmi changed the title ~~WIP: Public API for KMeansPredictor~~ Public API for KMeansPredictor Nov 28, 2018

singlis reviewed Nov 28, 2018

View reviewed changes

Reverting libmf commit id

073ff03

TomFinley reviewed Nov 29, 2018

View reviewed changes

src/Microsoft.ML.KMeansClustering/KMeansModelParameters.cs Show resolved Hide resolved

najeeb-kazmi added 2 commits December 3, 2018 16:31

Explicitly implementing IValueMapper and ICanSaveInTextFormat everywhere

68def92

Final cleanup

a36eb9b

TomFinley reviewed Dec 4, 2018

View reviewed changes

TomFinley approved these changes Dec 4, 2018

View reviewed changes

sfilipi reviewed Dec 4, 2018

View reviewed changes

docs/samples/Microsoft.ML.Samples/Dynamic/KMeans.cs Outdated Show resolved Hide resolved

sfilipi reviewed Dec 4, 2018

View reviewed changes

docs/samples/Microsoft.ML.Samples/Dynamic/KMeans.cs Outdated Show resolved Hide resolved

sfilipi reviewed Dec 4, 2018

View reviewed changes

src/Microsoft.ML.KMeansClustering/KMeansModelParameters.cs Show resolved Hide resolved

sfilipi approved these changes Dec 4, 2018

View reviewed changes

addressing some comments

5ca4465

najeeb-kazmi added 2 commits December 4, 2018 16:42

reverting namespace change

dbbfa64

update core_ep-list.tsv

a31d811

najeeb-kazmi merged commit a087ec5 into dotnet:master Dec 5, 2018

sfilipi mentioned this pull request Dec 7, 2018

MLContext extensions for trainers #1319

Closed

najeeb-kazmi deleted the 1699 branch January 30, 2020 01:12

ghost locked as resolved and limited conversation to collaborators Mar 26, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Public API for KMeansPredictor #1739

Public API for KMeansPredictor #1739

najeeb-kazmi commented Nov 27, 2018

wschin Nov 27, 2018

wschin Nov 27, 2018

singlis Nov 28, 2018

singlis Nov 28, 2018

TomFinley Dec 4, 2018 •

edited

Loading

singlis commented Nov 28, 2018

TomFinley commented Nov 29, 2018

TomFinley Dec 4, 2018

TomFinley left a comment

sfilipi Dec 4, 2018

TomFinley Dec 4, 2018

TomFinley Dec 4, 2018

najeeb-kazmi Dec 4, 2018

sfilipi Dec 4, 2018

najeeb-kazmi Dec 5, 2018

sfilipi left a comment


		namespace Microsoft.ML.Trainers.KMeans
		namespace Microsoft.ML.KMeansClustering

Public API for KMeansPredictor #1739

Public API for KMeansPredictor #1739

Conversation

najeeb-kazmi commented Nov 27, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

TomFinley Dec 4, 2018 • edited Loading

Choose a reason for hiding this comment

singlis commented Nov 28, 2018

TomFinley commented Nov 29, 2018

Choose a reason for hiding this comment

TomFinley left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sfilipi left a comment

Choose a reason for hiding this comment

TomFinley Dec 4, 2018 •

edited

Loading