Skip to content

get_prep_info_class_mlpGetPrepInfoClassMlpGetPrepInfoClassMlpget_prep_info_class_mlpT_get_prep_info_class_mlp๐Ÿ”—

Short description๐Ÿ”—

get_prep_info_class_mlpGetPrepInfoClassMlpGetPrepInfoClassMlpget_prep_info_class_mlpT_get_prep_info_class_mlp โ€” Compute the information content of the preprocessed feature vectors of a multilayer perceptron.

Signature๐Ÿ”—

get_prep_info_class_mlp( class_mlp MLPHandle, string Preprocessing, out real InformationCont, out real CumInformationCont )void GetPrepInfoClassMlp( const HTuple& MLPHandle, const HTuple& Preprocessing, HTuple* InformationCont, HTuple* CumInformationCont )static void HOperatorSet.GetPrepInfoClassMlp( HTuple MLPHandle, HTuple preprocessing, out HTuple informationCont, out HTuple cumInformationCont )def get_prep_info_class_mlp( mlphandle: HHandle, preprocessing: str ) -> Tuple[Sequence[float], Sequence[float]]

Herror T_get_prep_info_class_mlp( const Htuple MLPHandle, const Htuple Preprocessing, Htuple* InformationCont, Htuple* CumInformationCont )

HTuple HClassMlp::GetPrepInfoClassMlp( const HString& Preprocessing, HTuple* CumInformationCont ) const

HTuple HClassMlp::GetPrepInfoClassMlp( const char* Preprocessing, HTuple* CumInformationCont ) const

HTuple HClassMlp::GetPrepInfoClassMlp( const wchar_t* Preprocessing, HTuple* CumInformationCont ) const (Windows only)

HTuple HClassMlp.GetPrepInfoClassMlp( string preprocessing, out HTuple cumInformationCont )

Description๐Ÿ”—

get_prep_info_class_mlpGetPrepInfoClassMlp computes the information content of the training vectors that have been transformed with the preprocessing given by Preprocessingpreprocessingpreprocessing. Preprocessingpreprocessingpreprocessing can be set to 'principal_components'"principal_components" or 'canonical_variates'"canonical_variates". The preprocessing methods are described with create_class_mlpCreateClassMlp. The information content is derived from the variations of the transformed components of the feature vector, i.e., it is computed solely based on the training data, independent of any error rate on the training data. The information content is computed for all relevant components of the transformed feature vectors (NumInputnumInputnum_input for 'principal_components'"principal_components" and min(NumOutput - 1, NumInput) for 'canonical_variates'"canonical_variates", see create_class_mlpCreateClassMlp), and is returned in InformationContinformationContinformation_cont as a number between 0 and 1. To convert the information content into a percentage, it simply needs to be multiplied by 100. The cumulative information content of the first \(n\) components is returned in the \(n\)-th component of CumInformationContcumInformationContcum_information_cont, i.e., CumInformationContcumInformationContcum_information_cont contains the sums of the first \(n\) elements of InformationContinformationContinformation_cont. To use get_prep_info_class_mlpGetPrepInfoClassMlp, a sufficient number of samples must be added to the multilayer perceptron (MLP) given by MLPHandleMLPHandlemlphandle by using add_sample_class_mlpAddSampleClassMlp or read_samples_class_mlpReadSamplesClassMlp.

InformationContinformationContinformation_cont and CumInformationContcumInformationContcum_information_cont can be used to decide how many components of the transformed feature vectors contain relevant information. An often used criterion is to require that the transformed data must represent x% (e.g., 90%) of the data. This can be decided easily from the first value of CumInformationContcumInformationContcum_information_cont that lies above x%. The number thus obtained can be used as the value for NumComponentsnumComponentsnum_components in a new call to create_class_mlpCreateClassMlp. The call to get_prep_info_class_mlpGetPrepInfoClassMlp already requires the creation of an MLP, and hence the setting of NumComponentsnumComponentsnum_components in create_class_mlpCreateClassMlp to an initial value. However, if get_prep_info_class_mlpGetPrepInfoClassMlp is called it is typically not known how many components are relevant, and hence how to set NumComponentsnumComponentsnum_components in this call. Therefore, the following two-step approach should typically be used to select NumComponentsnumComponentsnum_components: In a first step, an MLP with the maximum number for NumComponentsnumComponentsnum_components is created (NumInputnumInputnum_input for 'principal_components'"principal_components" and min(NumOutput - 1, NumInput) for 'canonical_variates'"canonical_variates"). Then, the training samples are added to the MLP and are saved in a file using write_samples_class_mlpWriteSamplesClassMlp. Subsequently, get_prep_info_class_mlpGetPrepInfoClassMlp is used to determine the information content of the components, and with this NumComponentsnumComponentsnum_components. After this, a new MLP with the desired number of components is created, and the training samples are read with read_samples_class_mlpReadSamplesClassMlp. Finally, the MLP is trained with train_class_mlpTrainClassMlp.

Execution information๐Ÿ”—

Execution information
  • Multithreading type: reentrant (runs in parallel with non-exclusive operators).

  • Multithreading scope: global (may be called from any thread).

  • Processed without parallelization.

Parameters๐Ÿ”—

MLPHandleMLPHandlemlphandle (input_control) class_mlp โ†’ (handle)HTuple (HHandle)HClassMlp, HTuple (IntPtr)HHandleHtuple (handle)

MLP handle.

Preprocessingpreprocessingpreprocessing (input_control) string โ†’ (string)HTuple (HString)HTuple (string)strHtuple (char*)

Type of preprocessing used to transform the feature vectors.

Default: 'principal_components'"principal_components"
List of values: 'canonical_variates', 'principal_components'"canonical_variates", "principal_components"

InformationContinformationContinformation_cont (output_control) real-array โ†’ (real)HTuple (double)HTuple (double)Sequence[float]Htuple (double)

Relative information content of the transformed feature vectors.

CumInformationContcumInformationContcum_information_cont (output_control) real-array โ†’ (real)HTuple (double)HTuple (double)Sequence[float]Htuple (double)

Cumulative information content of the transformed feature vectors.

Example๐Ÿ”—

(HDevelop)


* Create the initial MLP
create_class_mlp (NumIn, NumHidden, NumOut, 'softmax', \
                  'principal_components', NumIn, 42, MLPHandle)
* Generate and add the training data
for J := 0 to NumData-1 by 1
    * Generate training features and classes
    * Data = [...]
    * Class = [...]
    add_sample_class_mlp (MLPHandle, Data, Class)
endfor
write_samples_class_mlp (MLPHandle, 'samples.mtf')
* Compute the information content of the transformed features
get_prep_info_class_mlp (MLPHandle, 'principal_components',\
                         InformationCont, CumInformationCont)
* Determine NumComp by inspecting InformationCont and CumInformationCont
* NumComp = [...]
* Create the actual MLP
create_class_mlp (NumIn, NumHidden, NumOut, 'softmax', \
                  'principal_components', NumComp, 42, MLPHandle)
* Train the MLP
read_samples_class_mlp (MLPHandle, 'samples.mtf')
train_class_mlp (MLPHandle, 100, 1, 0.01, Error, ErrorLog)
write_class_mlp (MLPHandle, 'classifier.mlp')

Result๐Ÿ”—

If the parameters are valid, the operator get_prep_info_class_mlpGetPrepInfoClassMlp returns the value 2 (H_MSG_TRUE). If necessary an exception is raised.

get_prep_info_class_mlpGetPrepInfoClassMlp may return the error 9211 (Matrix is not positive definite) if Preprocessingpreprocessingpreprocessing \(=\) 'canonical_variates'"canonical_variates" is used. This typically indicates that not enough training samples have been stored for each class.

Combinations with other operators๐Ÿ”—

Combinations

Possible predecessors

add_sample_class_mlpAddSampleClassMlp, read_samples_class_mlpReadSamplesClassMlp

Possible successors

clear_class_mlpClearClassMlp, create_class_mlpCreateClassMlp

References๐Ÿ”—

Christopher M. Bishop: โ€œNeural Networks for Pattern Recognitionโ€; Oxford University Press, Oxford; 1995.

Andrew Webb: โ€œStatistical Pattern Recognitionโ€; Arnold, London; 1999.

Module๐Ÿ”—

Foundation