data_models.strategies.api
data_models.strategies.api
Classes
| Name | Description |
|---|---|
| DoEStrategy | |
| FactorialStrategy | Factorial design strategy. |
| FractionalFactorialStrategy | Fractional factorial design strategy. |
| ActiveLearningStrategy | Datamodel for an ActiveLearningStrategy that focusses on pure exploration of the input space. |
| BotorchStrategy | |
| EntingStrategy | |
| MoboStrategy | |
| MultiFidelityStrategy | |
| MultiobjectiveStrategy | |
| AdditiveSoboStrategy | |
| CustomSoboStrategy |
DoEStrategy
data_models.strategies.api.DoEStrategy()Attributes
| Name | Description |
|---|---|
| return_fixed_candidates | Datamodel for strategy for design of experiments. This strategy is used to generate a set of |
FactorialStrategy
data_models.strategies.api.FactorialStrategy()Factorial design strategy.
This strategy is deprecated, please use FractionalFactorialStrategy instead.
FractionalFactorialStrategy
data_models.strategies.api.FractionalFactorialStrategy()Fractional factorial design strategy.
This strategy generates a fractional factorial two level design for the continuous part of the domain, which is then combined with the categorical part of the domain. For every categorical combination, the continuous part of the design is repeated.
ActiveLearningStrategy
data_models.strategies.api.ActiveLearningStrategy()Datamodel for an ActiveLearningStrategy that focusses on pure exploration of the input space. This type of strategy chooses new candidate points in order to minimize the uncertainty.
Methods
| Name | Description |
|---|---|
| is_feature_implemented | Method to check if a specific feature type is implemented for the strategy |
| is_objective_implemented | Method to check if a objective type is implemented for the strategy |
is_feature_implemented
data_models.strategies.api.ActiveLearningStrategy.is_feature_implemented(
my_type,
)Method to check if a specific feature type is implemented for the strategy
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| my_type | Type[Feature] | Feature class | required |
Returns
| Name | Type | Description |
|---|---|---|
| bool | bool | True if the feature type is valid for the strategy chosen, False otherwise |
is_objective_implemented
data_models.strategies.api.ActiveLearningStrategy.is_objective_implemented(
my_type,
)Method to check if a objective type is implemented for the strategy
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| my_type | Type[Objective] | Objective class | required |
Returns
| Name | Type | Description |
|---|---|---|
| bool | bool | True if the objective type is valid for the strategy chosen, False otherwise |
BotorchStrategy
data_models.strategies.api.BotorchStrategy()Methods
| Name | Description |
|---|---|
| is_constraint_implemented | Method to check if a specific constraint type is implemented for the strategy. For optimizer-specific |
| validate_multitask_allowed | Ensures that if a multitask model is used there is only a single allowed task category |
| validate_outlier_detection_specs_for_domain | Ensures that a outlier_detection model is specified for each output feature |
| validate_surrogate_specs | Ensures that a prediction model is specified for each output feature |
is_constraint_implemented
data_models.strategies.api.BotorchStrategy.is_constraint_implemented(my_type)Method to check if a specific constraint type is implemented for the strategy. For optimizer-specific strategies, this is passed to the optimizer check.
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| my_type | Type[Constraint] | Constraint class | required |
Returns
| Name | Type | Description |
|---|---|---|
| bool | bool | True if the constraint type is valid for the strategy chosen, False otherwise |
validate_multitask_allowed
data_models.strategies.api.BotorchStrategy.validate_multitask_allowed()Ensures that if a multitask model is used there is only a single allowed task category
validate_outlier_detection_specs_for_domain
data_models.strategies.api.BotorchStrategy.validate_outlier_detection_specs_for_domain(
)Ensures that a outlier_detection model is specified for each output feature
validate_surrogate_specs
data_models.strategies.api.BotorchStrategy.validate_surrogate_specs()Ensures that a prediction model is specified for each output feature
EntingStrategy
data_models.strategies.api.EntingStrategy()MoboStrategy
data_models.strategies.api.MoboStrategy()Methods
| Name | Description |
|---|---|
| is_feature_implemented | Method to check if a specific feature type is implemented for the strategy |
| is_objective_implemented | Method to check if a objective type is implemented for the strategy |
| validate_ref_point | Validate that the provided refpoint matches the provided domain. |
is_feature_implemented
data_models.strategies.api.MoboStrategy.is_feature_implemented(my_type)Method to check if a specific feature type is implemented for the strategy
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| my_type | Type[Feature] | Feature class | required |
Returns
| Name | Type | Description |
|---|---|---|
| bool | bool | True if the feature type is valid for the strategy chosen, False otherwise |
is_objective_implemented
data_models.strategies.api.MoboStrategy.is_objective_implemented(my_type)Method to check if a objective type is implemented for the strategy
Parameters
| Name | Type | Description | Default |
|---|---|---|---|
| my_type | Type[Objective] | Objective class | required |
Returns
| Name | Type | Description |
|---|---|---|
| bool | bool | True if the objective type is valid for the strategy chosen, False otherwise |
validate_ref_point
data_models.strategies.api.MoboStrategy.validate_ref_point()Validate that the provided refpoint matches the provided domain.
MultiFidelityStrategy
data_models.strategies.api.MultiFidelityStrategy()Methods
| Name | Description |
|---|---|
| validate_multitask_allowed | Overwrites BotorchSurrogate.validate_multitask_allowed, as multiple tasks are allowed. |
| validate_only_one_target_fidelity | Ensures that there is only one target fidelity (task where fidelity==0). |
| validate_surrogate_specs | Ensures that a multi-task model is specified for each output feature |
| validate_tasks_and_fidelity_thresholds | Ensures that there is one threshold per fidelity |
validate_multitask_allowed
data_models.strategies.api.MultiFidelityStrategy.validate_multitask_allowed()Overwrites BotorchSurrogate.validate_multitask_allowed, as multiple tasks are allowed.
validate_only_one_target_fidelity
data_models.strategies.api.MultiFidelityStrategy.validate_only_one_target_fidelity(
)Ensures that there is only one target fidelity (task where fidelity==0).
validate_surrogate_specs
data_models.strategies.api.MultiFidelityStrategy.validate_surrogate_specs()Ensures that a multi-task model is specified for each output feature
validate_tasks_and_fidelity_thresholds
data_models.strategies.api.MultiFidelityStrategy.validate_tasks_and_fidelity_thresholds(
)Ensures that there is one threshold per fidelity
MultiobjectiveStrategy
data_models.strategies.api.MultiobjectiveStrategy()Methods
| Name | Description |
|---|---|
| validate_domain_is_multiobjective | Validate that the domain is multiobjective. |
validate_domain_is_multiobjective
data_models.strategies.api.MultiobjectiveStrategy.validate_domain_is_multiobjective(
v,
)Validate that the domain is multiobjective.
AdditiveSoboStrategy
data_models.strategies.api.AdditiveSoboStrategy()CustomSoboStrategy
data_models.strategies.api.CustomSoboStrategy()