CreateModelBase Struct Reference
Last update: 16.07.2025API for all MOP3 model creation classes. More...
Public Member Functions | |
| virtual string | __str__ () |
| Output function used in python context. Use this function to print instances of this class in python. More... | |
| virtual | addProperty (PropertyBase p) |
| Properties that help the ScalarMOP scheduling the Models to be built The properties class needs to be implemented for the specific model type. | |
| virtual ModelBase * | compute (::data_handler::DataHandlerBase datahandler, TrainingPlanBase training_plan, quality_measure::QualityMeasureBase quality_measure, CancelBase *cancel=nullptr)=0 |
| Builds the model from the given samples and returns the model. More... | |
| virtual bool | equals (CreateModelBase other)=0 |
| Checking if the given configurations are equal this this instance. More... | |
| virtual PropertyList | getProperties () |
| Returns the properties stored by this user. | |
| virtual bool | isValid (::data_handler::DataHandlerBase datahandler, TrainingPlanBase training_plan)=0 |
| This function checks if the model can validly be trained from the given samples. More... | |
| CreateModelBase | operator= (CreateModelBase other) |
| assignement operator More... | |
| virtual | transferProperties (PropertyList property_list) |
| Convenience function to transfer a complete PropertyList into the model. More... | |
Public Attributes | |
| string | node_name |
| string | working_dir |
Detailed Description
API for all MOP3 model creation classes.
Member Function Documentation
◆ __str__()
|
virtual |
Output function used in python context. Use this function to print instances of this class in python.
- Returns
- string containing the object
Reimplemented in CreateCustomModel.
◆ compute()
|
pure virtual |
Builds the model from the given samples and returns the model.
- Parameters
-
datahandler The datahandler that contains the samples training_plan The training plan that specifies how the model will be trained quality_measure The quality measure that allows to compute a models approximation quality cancel A cancellation object to cancel the training
- Returns
- The trained model iff not cancelled
Implemented in CreateCustomModel.
◆ equals()
|
pure virtual |
Checking if the given configurations are equal this this instance.
- Parameters
-
other The other Config
- Returns
- true iff the same type and the same config entries
Implemented in CreateCustomModel.
◆ isValid()
|
pure virtual |
This function checks if the model can validly be trained from the given samples.
- Parameters
-
datahandler The samples the model shall be trained with. training_plan The training_plan
- Returns
- True iff th emodel can be trained with the configuration data, the properties and samples
Implemented in CreateCustomModel, CreateKrigingModel, CreateMLSModel, CreateRBFModel, CreatePolynomialModel, CreateLegacyMOPModel, and CreateLegacyMOQModel.
◆ operator=()
| CreateModelBase operator= | ( | CreateModelBase | other | ) |
assignement operator
- Returns
- A raw of type CreateModelBase to cloned instance
◆ transferProperties()
|
virtualinherited |
Convenience function to transfer a complete PropertyList into the model.
- Parameters
-
property_list The properties to transfer into this model
