Lockdown Microsoft.ML.Recommender public surface

Author: Ivan Matantsev

src/Microsoft.ML.Recommender/MatrixFactorizationPredictor.cs

@@ -64,10 +64,10 @@ public PredictionKind PredictionKind
             get { return PredictionKind.Recommendation; }
         }
 
-        public ColumnType OutputType { get { return NumberType.Float; } }
+        private ColumnType OutputType { get { return NumberType.Float; } }
 
-        public ColumnType MatrixColumnIndexType { get; }
-        public ColumnType MatrixRowIndexType { get; }
+        internal ColumnType MatrixColumnIndexType { get; }
+        internal ColumnType MatrixRowIndexType { get; }
 
         internal MatrixFactorizationPredictor(IHostEnvironment env, SafeTrainingAndModelBuffer buffer, KeyType matrixColumnIndexType, KeyType matrixRowIndexType)
         {
@@ -131,7 +131,7 @@ private MatrixFactorizationPredictor(IHostEnvironment env, ModelLoadContext ctx)
         /// <summary>
         /// Load model from the given context
         /// </summary>
-        public static MatrixFactorizationPredictor Create(IHostEnvironment env, ModelLoadContext ctx)
+        private static MatrixFactorizationPredictor Create(IHostEnvironment env, ModelLoadContext ctx)
         {
             Contracts.CheckValue(env, nameof(env));
             env.CheckValue(ctx, nameof(ctx));
@@ -377,11 +377,11 @@ public Row GetRow(Row input, Func<int, bool> active)
 
     public sealed class MatrixFactorizationPredictionTransformer : PredictionTransformerBase<MatrixFactorizationPredictor, GenericScorer>, ICanSaveModel
     {
-        public const string LoaderSignature = "MaFactPredXf";
-        public string MatrixColumnIndexColumnName { get; }
-        public string MatrixRowIndexColumnName { get; }
-        public ColumnType MatrixColumnIndexColumnType { get; }
-        public ColumnType MatrixRowIndexColumnType { get; }
+        internal const string LoaderSignature = "MaFactPredXf";
+        internal string MatrixColumnIndexColumnName { get; }
+        internal string MatrixRowIndexColumnName { get; }
+        internal ColumnType MatrixColumnIndexColumnType { get; }
+        internal ColumnType MatrixRowIndexColumnType { get; }
         protected override GenericScorer Scorer { get; set; }
 
         /// <summary>
@@ -396,7 +396,7 @@ public sealed class MatrixFactorizationPredictionTransformer : PredictionTransfo
         /// <param name="matrixColumnIndexColumnName">The name of the column used as role <see cref="RecommenderUtils.MatrixColumnIndexKind"/> in matrix factorization world</param>
         /// <param name="matrixRowIndexColumnName">The name of the column used as role <see cref="RecommenderUtils.MatrixRowIndexKind"/> in matrix factorization world</param>
         /// <param name="scoreColumnNameSuffix">A string attached to the output column name of this transformer</param>
-        public MatrixFactorizationPredictionTransformer(IHostEnvironment env, MatrixFactorizationPredictor model, Schema trainSchema,
+        internal MatrixFactorizationPredictionTransformer(IHostEnvironment env, MatrixFactorizationPredictor model, Schema trainSchema,
             string matrixColumnIndexColumnName, string matrixRowIndexColumnName, string scoreColumnNameSuffix = "")
             : base(Contracts.CheckRef(env, nameof(env)).Register(nameof(MatrixFactorizationPredictionTransformer)), model, trainSchema)
         {
@@ -433,7 +433,7 @@ private RoleMappedSchema GetSchema()
         /// The counter constructor of re-creating <see cref="MatrixFactorizationPredictionTransformer"/> from the context where
         /// the original transform is saved.
         /// </summary>
-        public MatrixFactorizationPredictionTransformer(IHostEnvironment host, ModelLoadContext ctx)
+        private MatrixFactorizationPredictionTransformer(IHostEnvironment host, ModelLoadContext ctx)
             : base(Contracts.CheckRef(host, nameof(host)).Register(nameof(MatrixFactorizationPredictionTransformer)), ctx)
         {
             // *** Binary format ***

src/Microsoft.ML.Recommender/MatrixFactorizationTrainer.cs

@@ -197,7 +197,7 @@ public sealed class Options
         private readonly bool _doNmf;
 
         public override PredictionKind PredictionKind => PredictionKind.Recommendation;
-        public const string LoadNameValue = "MatrixFactorization";
+        internal const string LoadNameValue = "MatrixFactorization";
 
         /// <summary>
         /// The row index, column index, and label columns needed to specify the training matrix. This trainer uses tuples of (row index, column index, label value) to specify a matrix.
@@ -427,6 +427,10 @@ public MatrixFactorizationPredictionTransformer Train(IDataView trainData, IData
         /// <param name="input">The training data set.</param>
         public MatrixFactorizationPredictionTransformer Fit(IDataView input) => Train(input);
 
+        /// <summary>
+        /// Schema propagation for transformers. Returns the output schema of the data, if
+        /// the input schema is like the one provided.
+        /// </summary>
         public SchemaShape GetOutputSchema(SchemaShape inputSchema)
         {
             Host.CheckValue(inputSchema, nameof(inputSchema));

src/Microsoft.ML.StandardLearners/FactorizationMachine/FactorizationMachineTrainer.cs

@@ -511,6 +511,10 @@ public FieldAwareFactorizationMachinePredictionTransformer Train(IDataView train
 
         public FieldAwareFactorizationMachinePredictionTransformer Fit(IDataView input) => Train(input);
 
+        /// <summary>
+        /// Schema propagation for transformers. Returns the output schema of the data, if
+        /// the input schema is like the one provided.
+        /// </summary>
         public SchemaShape GetOutputSchema(SchemaShape inputSchema)
         {