Commit 44e00450 authored by Cédric Traizet's avatar Cédric Traizet
Browse files

DOC: more kmeans doc

No related merge requests found
Showing with 10 additions and 6 deletions
+10 -6
...@@ -77,7 +77,8 @@ protected: ...@@ -77,7 +77,8 @@ protected:
MandatoryOff("ts"); MandatoryOff("ts");
AddParameter(ParameterType_Int, "maxit", "Maximum number of iterations"); AddParameter(ParameterType_Int, "maxit", "Maximum number of iterations");
SetParameterDescription("maxit", "Maximum number of iterations for the learning step."); SetParameterDescription("maxit", "Maximum number of iterations for the learning step."
" If this parameter is set to 0, the KMeans algorithm will not stop until convergence");
SetDefaultParameterInt("maxit", 1000); SetDefaultParameterInt("maxit", 1000);
MandatoryOff("maxit"); MandatoryOff("maxit");
...@@ -86,7 +87,9 @@ protected: ...@@ -86,7 +87,9 @@ protected:
"Group of parameters for centroids IO." ); "Group of parameters for centroids IO." );
AddParameter(ParameterType_InputFilename, "centroids.in", "input centroids text file"); AddParameter(ParameterType_InputFilename, "centroids.in", "input centroids text file");
SetParameterDescription("centroids.in", "Input text file containing centroid posistions."); SetParameterDescription("centroids.in", "Input text file containing centroid posistions used to initialize the algorithm."
" The file must contain one centroid per line, and each centroid value must be separated by a space. The number of"
" centroids in this file must match the number of classes (nc parameter).");
MandatoryOff("centroids.in"); MandatoryOff("centroids.in");
ShareKMSamplingParameters(); ShareKMSamplingParameters();
......
...@@ -46,14 +46,15 @@ void LearningApplicationBase<TInputValue, TOutputValue>::InitSharkKMeansParams() ...@@ -46,14 +46,15 @@ void LearningApplicationBase<TInputValue, TOutputValue>::InitSharkKMeansParams()
SetParameterDescription("classifier.sharkkm.k", "The number of classes used for the kmeans algorithm. Default set to 2 class"); SetParameterDescription("classifier.sharkkm.k", "The number of classes used for the kmeans algorithm. Default set to 2 class");
SetMinimumParameterIntValue("classifier.sharkkm.k", 2); SetMinimumParameterIntValue("classifier.sharkkm.k", 2);
// Centroid IO
AddParameter( ParameterType_Group, "classifier.sharkkm.centroids", "Centroids IO parameters" ); AddParameter( ParameterType_Group, "classifier.sharkkm.centroids", "Centroids IO parameters" );
SetParameterDescription( "classifier.sharkkm.centroids", "Group of parameters for centroids IO." ); SetParameterDescription( "classifier.sharkkm.centroids", "Group of parameters for centroids IO." );
// Input centroids // Input centroids
AddParameter(ParameterType_InputFilename, "classifier.sharkkm.centroids.in", "User definied input centroids"); AddParameter(ParameterType_InputFilename, "classifier.sharkkm.centroids.in", "User definied input centroids");
SetParameterDescription("classifier.sharkkm.centroids", "Text file containing input centroids."); SetParameterDescription("classifier.sharkkm.centroids.in", "Input text file containing centroid posistions used to initialize the algorithm."
" The file must contain one centroid per line, and each centroid value must be separated by a space. The number of"
" centroids in this file must match the number of classes (classifier.sharkkm.k).");
MandatoryOff("classifier.sharkkm.centroids"); MandatoryOff("classifier.sharkkm.centroids");
// Centroid statistics // Centroid statistics
...@@ -62,7 +63,7 @@ void LearningApplicationBase<TInputValue, TOutputValue>::InitSharkKMeansParams() ...@@ -62,7 +63,7 @@ void LearningApplicationBase<TInputValue, TOutputValue>::InitSharkKMeansParams()
"and reduce the centroids before the KMeans algorithm, produced by ComputeImagesStatistics application."); "and reduce the centroids before the KMeans algorithm, produced by ComputeImagesStatistics application.");
MandatoryOff("classifier.sharkkm.centroids.stats"); MandatoryOff("classifier.sharkkm.centroids.stats");
// output centroids // Output centroids
AddParameter(ParameterType_OutputFilename, "classifier.sharkkm.centroids.out", "Output centroids text file"); AddParameter(ParameterType_OutputFilename, "classifier.sharkkm.centroids.out", "Output centroids text file");
SetParameterDescription("classifier.sharkkm.centroids.out", "Output text file containing centroids after the kmean algorithm."); SetParameterDescription("classifier.sharkkm.centroids.out", "Output text file containing centroids after the kmean algorithm.");
MandatoryOff("classifier.sharkkm.centroids.out"); MandatoryOff("classifier.sharkkm.centroids.out");
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment