Coverage for tadkit/utils/tadlearner_factory.py: 92%

1from typing import TypeVar, Sequence, Type, Optional 

2 

3from tadkit.base.tadlearner import TADLearner 

4from tadkit.base.typing import KWParams, ParamsDescription 

5 

6Estimator = TypeVar("Estimator") 

7 

8 

9def tadlearner_factory( 

10 Model: Type[Estimator], 

11 required_properties: Sequence[str], 

12 params_description: ParamsDescription, 

13 name: Optional[str] = None, 

14) -> Type[TADLearner]: 

15 """Wrap a sklearn anomaly detection model to a TADLearner. 

16 

17 Args: 

18 Model: sklearn type model- to wrapp, possessing get_params, fit and score_samples methods. 

19 required_properties: The properties that the input data must satisfies. 

20 params_description: Description of the kwargs of the __init__ method that is exposed. 

21 name: The Name of the class. Default name if None. 

22 

23 Returns: 

24 A subclass of TADLearner wrapping Model with given required_properties, params_description 

25 and __name__. 

26 """ 

27 

28 if name is None: 

29 name = Model.__name__ + "Learner" 

30 

31 def __init__(self, **params: KWParams): 

32 Model.__init__(self, **params) 

33 

34 Model.name = name 

35 Model.required_properties = required_properties 

36 Model.params_description = params_description 

37 return Model