clear_training_componentsT_clear_training_componentsClearTrainingComponentsClearTrainingComponents (Operator)

Name

clear_training_componentsT_clear_training_componentsClearTrainingComponentsClearTrainingComponents — Free the memory of a component training result.

Signature

Description

The operator clear_training_componentsclear_training_componentsClearTrainingComponentsClearTrainingComponentsClearTrainingComponents frees the memory of a training result that was created by train_model_componentstrain_model_componentsTrainModelComponentsTrainModelComponentsTrainModelComponents. After calling clear_training_componentsclear_training_componentsClearTrainingComponentsClearTrainingComponentsClearTrainingComponents, the training result can no longer be used. The handle ComponentTrainingIDComponentTrainingIDComponentTrainingIDComponentTrainingIDcomponentTrainingID becomes invalid.

Execution Information

• Multithreading type: reentrant (runs in parallel with non-exclusive operators).
• Multithreading scope: global (may be called from any thread).
• Processed without parallelization.

This operator modifies the state of the following input parameter:

• ComponentTrainingIDComponentTrainingIDComponentTrainingIDComponentTrainingIDcomponentTrainingID

During execution of this operator, access to the value of this parameter must be synchronized if it is used across multiple threads.

Parameters

Result

If the handle of the training result is valid, the operator clear_training_componentsclear_training_componentsClearTrainingComponentsClearTrainingComponentsClearTrainingComponents returns the value 2 (H_MSG_TRUE). If necessary, an exception is raised.

Possible Predecessors

train_model_componentstrain_model_componentsTrainModelComponentsTrainModelComponentsTrainModelComponents, write_training_componentswrite_training_componentsWriteTrainingComponentsWriteTrainingComponentsWriteTrainingComponents

Module

Matching