Commit 10dc6489 authored by Guillaume Pasero's avatar Guillaume Pasero
Browse files

DOC: fix applications doc

No related merge requests found
Showing with 21 additions and 2 deletions
+21 -2
...@@ -71,8 +71,18 @@ private: ...@@ -71,8 +71,18 @@ private:
void DoInit() void DoInit()
{ {
SetName("TrainDimensionalityReduction"); SetName("TrainDimensionalityReduction");
SetDescription("Trainer for the dimensionality reduction algorithms used in" SetDescription("Train a dimensionality reduction model");
" the ImageDimensionalityReduction and VectorDimensionalityReduction applications.");
SetDocName("Train Dimensionality Reduction");
SetDocLongDescription("Trainer for dimensionality reduction algorithms "
"(autoencoders, PCA, SOM). All input samples are used to compute the "
"model, like other machine learning models.\n"
"The model can be used in the ImageDimensionalityReduction and "
"VectorDimensionalityReduction applications.");
SetDocLimitations("None");
SetDocAuthors("OTB-Team");
SetDocSeeAlso("ImageDimensionalityReduction, VectorDimensionalityReduction");
AddParameter(ParameterType_Group, "io", "Input and output data"); AddParameter(ParameterType_Group, "io", "Input and output data");
SetParameterDescription("io", "This group of parameters allows setting input and output data."); SetParameterDescription("io", "This group of parameters allows setting input and output data.");
...@@ -95,6 +105,14 @@ private: ...@@ -95,6 +105,14 @@ private:
Superclass::DoInit(); Superclass::DoInit();
AddRAMParameter(); AddRAMParameter();
// Doc example parameter settings
SetDocExampleParameterValue("io.vd", "cuprite_samples.sqlite");
SetDocExampleParameterValue("io.out", "mode.ae");
SetDocExampleParameterValue("algorithm", "pca");
SetDocExampleParameterValue("algorithm.pca.dim", "8");
SetDocExampleParameterValue("feat","value_0 value_1 value_2 value_3 value_4"
" value_5 value_6 value_7 value_8 value_9");
} }
void DoUpdateParameters() void DoUpdateParameters()
......
...@@ -92,6 +92,7 @@ private: ...@@ -92,6 +92,7 @@ private:
"dimensionality reduction based on a model file produced by the " "dimensionality reduction based on a model file produced by the "
"TrainDimensionalityReduction application."); "TrainDimensionalityReduction application.");
SetDocSeeAlso("TrainDimensionalityReduction"); SetDocSeeAlso("TrainDimensionalityReduction");
SetDocLimitations("None");
AddDocTag(Tags::Learning); AddDocTag(Tags::Learning);
AddParameter(ParameterType_InputVectorData, "in", "Name of the input vector data"); AddParameter(ParameterType_InputVectorData, "in", "Name of the input vector data");
......
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