From 23ae6ede92c268283a7cd4c019e136cfb4596647 Mon Sep 17 00:00:00 2001 From: Pierre Alexandre Tremblay Date: Wed, 5 Aug 2020 20:46:06 +0100 Subject: [PATCH] correct the definition of pca variance --- release-packaging/HelpSource/Classes/FluidPCA.schelp | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/release-packaging/HelpSource/Classes/FluidPCA.schelp b/release-packaging/HelpSource/Classes/FluidPCA.schelp index faf5453..0cc3329 100644 --- a/release-packaging/HelpSource/Classes/FluidPCA.schelp +++ b/release-packaging/HelpSource/Classes/FluidPCA.schelp @@ -36,7 +36,7 @@ Source data, or the DataSet name ARGUMENT:: destDataSet Destination data, or the DataSet name ARGUMENT:: action -Run when done. The variance is passed as an argument, aka the error of the new representation: a lower value means a higher fidelity to the original. +Run when done. The variance is passed as an argument, aka the fidelity of the new representation: a value near 1.0 means a higher fidelity to the original. METHOD:: fitTransform link::Classes/FluidPCA#fit:: and link::Classes/FluidPCA#transform:: in a single pass @@ -45,7 +45,7 @@ Source data, or the DataSet name ARGUMENT:: destDataSet Destination data, or the DataSet name ARGUMENT:: action -Run when done. The variance is passed as an argument, aka the error of the new representation: a lower value means a higher fidelity to the original. +Run when done. The variance is passed as an argument, aka the fidelity of the new representation: a value near 1.0 means a higher fidelity to the original. METHOD:: transformPoint Given a trained model, transform the data point in a link::Classes/Buffer:: and write to an output @@ -54,7 +54,7 @@ Input data ARGUMENT:: destBuffer Output data ARGUMENT:: action -Run when done. The variance is passed as an argument, aka the error of the new representation: a lower value means a higher fidelity to the original. +Run when done. The variance is passed as an argument, aka the fidelity of the new representation: a value near 1.0 means a higher fidelity to the original. EXAMPLES::