Remove some advanced parameters in simple API

dotnet · Mar 9, 2019 · eac9227 · eac9227
1 parent 5839e66
commit eac9227
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 21 deletions.
diff --git a/docs/samples/Microsoft.ML.Samples/Dynamic/LdaTransform.cs b/docs/samples/Microsoft.ML.Samples/Dynamic/LdaTransform.cs
@@ -30,7 +30,7 @@ public static void Example()
 
             // A pipeline for featurizing the "Review" column
             var pipeline = ml.Transforms.Text.ProduceWordBags(review).
-                Append(ml.Transforms.Text.LatentDirichletAllocation(review, ldaFeatures, numberOfTopics:3));
+                Append(ml.Transforms.Text.LatentDirichletAllocation(review, ldaFeatures, numberOfTopics: 3));
 
             // The transformed data
             var transformer = pipeline.Fit(trainData);

diff --git a/src/Microsoft.ML.Transforms/Text/LdaTransform.cs b/src/Microsoft.ML.Transforms/Text/LdaTransform.cs
@@ -945,10 +945,10 @@ internal static class Defaults
         /// <param name="beta">Dirichlet prior on vocab-topic vectors.</param>
         /// <param name="samplingStepCount">Number of Metropolis Hasting step.</param>
         /// <param name="maximumNumberOfIterations">Number of iterations.</param>
-        /// <param name="likelihoodInterval">Compute log likelihood over local dataset on this iteration interval.</param>
         /// <param name="numberOfThreads">The number of training threads. Default value depends on number of logical processors.</param>
         /// <param name="maximumTokenCountPerDocument">The threshold of maximum count of tokens per doc.</param>
         /// <param name="numberOfSummaryTermsPerTopic">The number of words to summarize the topic.</param>
+        /// <param name="likelihoodInterval">Compute log likelihood over local dataset on this iteration interval.</param>
         /// <param name="numberOfBurninIterations">The number of burn-in iterations.</param>
         /// <param name="resetRandomGenerator">Reset the random number generator for each document.</param>
         internal LatentDirichletAllocationEstimator(IHostEnvironment env,
@@ -958,10 +958,10 @@ internal static class Defaults
             float beta = Defaults.Beta,
             int samplingStepCount = Defaults.SamplingStepCount,
             int maximumNumberOfIterations = Defaults.MaximumNumberOfIterations,
-            int likelihoodInterval = Defaults.LikelihoodInterval,
             int numberOfThreads = Defaults.NumberOfThreads,
             int maximumTokenCountPerDocument = Defaults.MaximumTokenCountPerDocument,
             int numberOfSummaryTermsPerTopic = Defaults.NumberOfSummaryTermsPerTopic,
+            int likelihoodInterval = Defaults.LikelihoodInterval,
             int numberOfBurninIterations = Defaults.NumberOfBurninIterations,
             bool resetRandomGenerator = Defaults.ResetRandomGenerator)
             : this(env, new[] { new ColumnOptions(outputColumnName, inputColumnName ?? outputColumnName,

diff --git a/src/Microsoft.ML.Transforms/Text/TextCatalog.cs b/src/Microsoft.ML.Transforms/Text/TextCatalog.cs
@@ -580,16 +580,9 @@ public static class TextCatalog
         /// <param name="outputColumnName">Name of the column resulting from the transformation of <paramref name="inputColumnName"/>.</param>
         /// <param name="inputColumnName">Name of the column to transform. If set to <see langword="null"/>, the value of the <paramref name="outputColumnName"/> will be used as source.</param>
         /// <param name="numberOfTopics">The number of topics.</param>
-        /// <param name="alphaSum">Dirichlet prior on document-topic vectors.</param>
-        /// <param name="beta">Dirichlet prior on vocab-topic vectors.</param>
-        /// <param name="samplingStepCount">Number of Metropolis Hasting step.</param>
         /// <param name="maximumNumberOfIterations">Number of iterations.</param>
-        /// <param name="likelihoodInterval">Compute log likelihood over local dataset on this iteration interval.</param>
-        /// <param name="numberOfThreads">The number of training threads. Default value depends on number of logical processors.</param>
         /// <param name="maximumTokenCountPerDocument">The threshold of maximum count of tokens per doc.</param>
         /// <param name="numberOfSummaryTermsPerTopic">The number of words to summarize the topic.</param>
-        /// <param name="numberOfBurninIterations">The number of burn-in iterations.</param>
-        /// <param name="resetRandomGenerator">Reset the random number generator for each document.</param>
         /// <example>
         /// <format type="text/markdown">
         /// <![CDATA[
@@ -601,19 +594,21 @@ public static class TextCatalog
             string outputColumnName,
             string inputColumnName = null,
             int numberOfTopics = LatentDirichletAllocationEstimator.Defaults.NumberOfTopics,
-            float alphaSum = LatentDirichletAllocationEstimator.Defaults.AlphaSum,
-            float beta = LatentDirichletAllocationEstimator.Defaults.Beta,
-            int samplingStepCount = LatentDirichletAllocationEstimator.Defaults.SamplingStepCount,
             int maximumNumberOfIterations = LatentDirichletAllocationEstimator.Defaults.MaximumNumberOfIterations,
-            int likelihoodInterval = LatentDirichletAllocationEstimator.Defaults.LikelihoodInterval,
-            int numberOfThreads = LatentDirichletAllocationEstimator.Defaults.NumberOfThreads,
             int maximumTokenCountPerDocument = LatentDirichletAllocationEstimator.Defaults.MaximumTokenCountPerDocument,
-            int numberOfSummaryTermsPerTopic = LatentDirichletAllocationEstimator.Defaults.NumberOfSummaryTermsPerTopic,
-            int numberOfBurninIterations = LatentDirichletAllocationEstimator.Defaults.NumberOfBurninIterations,
-            bool resetRandomGenerator = LatentDirichletAllocationEstimator.Defaults.ResetRandomGenerator)
+            int numberOfSummaryTermsPerTopic = LatentDirichletAllocationEstimator.Defaults.NumberOfSummaryTermsPerTopic)
             => new LatentDirichletAllocationEstimator(CatalogUtils.GetEnvironment(catalog),
-                outputColumnName, inputColumnName, numberOfTopics, alphaSum, beta, samplingStepCount, maximumNumberOfIterations, likelihoodInterval, numberOfThreads,
-                maximumTokenCountPerDocument, numberOfSummaryTermsPerTopic, numberOfBurninIterations, resetRandomGenerator);
+                outputColumnName, inputColumnName, numberOfTopics,
+                LatentDirichletAllocationEstimator.Defaults.AlphaSum,
+                LatentDirichletAllocationEstimator.Defaults.Beta,
+                LatentDirichletAllocationEstimator.Defaults.SamplingStepCount,
+                maximumNumberOfIterations,
+                LatentDirichletAllocationEstimator.Defaults.NumberOfThreads,
+                maximumTokenCountPerDocument,
+                numberOfSummaryTermsPerTopic,
+                LatentDirichletAllocationEstimator.Defaults.LikelihoodInterval,
+                LatentDirichletAllocationEstimator.Defaults.NumberOfBurninIterations,
+                LatentDirichletAllocationEstimator.Defaults.ResetRandomGenerator);
 
         /// <summary>
         /// Uses <a href="https://arxiv.org/abs/1412.1576">LightLDA</a> to transform a document (represented as a vector of floats)

diff --git a/test/Microsoft.ML.TestFramework/DataPipe/TestDataPipe.cs b/test/Microsoft.ML.TestFramework/DataPipe/TestDataPipe.cs
@@ -11,6 +11,7 @@
 using Microsoft.ML.Internal.Utilities;
 using Microsoft.ML.Runtime;
 using Microsoft.ML.Transforms;
+using Microsoft.ML.Transforms.Text;
 using Xunit;
 
 namespace Microsoft.ML.RunTests
@@ -1318,7 +1319,9 @@ public void TestLDATransform()
             builder.AddColumn("F1V", NumberDataViewType.Single, data);
             var srcView = builder.GetDataView();
 
-            var est = ML.Transforms.Text.LatentDirichletAllocation("F1V", numberOfTopics: 3, numberOfSummaryTermsPerTopic: 3, alphaSum: 3, numberOfThreads: 1, resetRandomGenerator: true);
+            var opt = new LatentDirichletAllocationEstimator.ColumnOptions(name: "F1V", numberOfTopics: 3,
+                numberOfSummaryTermsPerTopic: 3, alphaSum: 3, numberOfThreads: 1, resetRandomGenerator: true);
+            var est = ML.Transforms.Text.LatentDirichletAllocation(opt);
             var ldaTransformer = est.Fit(srcView);
             var transformedData = ldaTransformer.Transform(srcView);