GitHub

romtools.workflows.model_builders

Protocol for building a model This is mainly used for constructing data-driven models in iterative workflows like greedy

 1'''
 2Protocol for building a model
 3This is mainly used for constructing data-driven models in
 4iterative workflows like greedy
 5'''
 6
 7from typing import Protocol, List
 8from romtools.workflows.models import Model, QoiModel, QoiModelWithErrorEstimate
 9
10class ModelBuilder(Protocol):
11    '''
12    Main protocol for a ModelBuilder.
13
14    Methods:
15    '''
16    def __init__(self):
17        pass
18
19    def build_from_training_dirs(self,offline_data_dir: str, training_data_dirs: List[str]) -> Model:
20        pass
21
22
23class QoiModelBuilder(Protocol):
24    '''
25    Main protocol for a QoiModelBuilder.
26
27    Methods:
28    '''
29
30    def __init__(self):
31        pass
32
33    def build_from_training_dirs(self,offline_data_dir: str, training_data_dirs: List[str]) -> QoiModel:
34        pass
35
36
37class QoiModelWithErrorEstimateBuilder(Protocol):
38    '''
39    Main protocol for a QoiModelWithErrorEstimateBuilder.
40
41    Methods:
42    '''
43
44    def __init__(self):
45        pass
46
47    def build_from_training_dirs(self,offline_data_dir: str, training_data_dirs: List[str]) -> QoiModelWithErrorEstimate:
48        return QoiModelWithErrorEstimate
class ModelBuilder(typing.Protocol): 
11class ModelBuilder(Protocol):
12    '''
13    Main protocol for a ModelBuilder.
14
15    Methods:
16    '''
17    def __init__(self):
18        pass
19
20    def build_from_training_dirs(self,offline_data_dir: str, training_data_dirs: List[str]) -> Model:
21        pass

Main protocol for a ModelBuilder.

Methods:

def build_from_training_dirs( self, offline_data_dir: str, training_data_dirs: List[str]) -> romtools.workflows.models.Model: 
20    def build_from_training_dirs(self,offline_data_dir: str, training_data_dirs: List[str]) -> Model:
21        pass
class QoiModelBuilder(typing.Protocol): 
24class QoiModelBuilder(Protocol):
25    '''
26    Main protocol for a QoiModelBuilder.
27
28    Methods:
29    '''
30
31    def __init__(self):
32        pass
33
34    def build_from_training_dirs(self,offline_data_dir: str, training_data_dirs: List[str]) -> QoiModel:
35        pass

Main protocol for a QoiModelBuilder.

Methods:

def build_from_training_dirs( self, offline_data_dir: str, training_data_dirs: List[str]) -> romtools.workflows.models.QoiModel: 
34    def build_from_training_dirs(self,offline_data_dir: str, training_data_dirs: List[str]) -> QoiModel:
35        pass
class QoiModelWithErrorEstimateBuilder(typing.Protocol): 
38class QoiModelWithErrorEstimateBuilder(Protocol):
39    '''
40    Main protocol for a QoiModelWithErrorEstimateBuilder.
41
42    Methods:
43    '''
44
45    def __init__(self):
46        pass
47
48    def build_from_training_dirs(self,offline_data_dir: str, training_data_dirs: List[str]) -> QoiModelWithErrorEstimate:
49        return QoiModelWithErrorEstimate

Main protocol for a QoiModelWithErrorEstimateBuilder.

Methods:

def build_from_training_dirs( self, offline_data_dir: str, training_data_dirs: List[str]) -> romtools.workflows.models.QoiModelWithErrorEstimate: 
48    def build_from_training_dirs(self,offline_data_dir: str, training_data_dirs: List[str]) -> QoiModelWithErrorEstimate:
49        return QoiModelWithErrorEstimate