Coverage for credoai/artifacts/model/regression_model.py: 64%

1"""Model artifact wrapping any regression model""" 

2from .base_model import Model 

3 

4 

5class RegressionModel(Model): 

6 """Class wrapper around classification model to be assessed 

7 

8 RegressionModel serves as an adapter between arbitrary regression models and the 

9 evaluations in Lens. Evaluations depend on 

10 RegressionModel instantiating `predict` 

11 

12 Parameters 

13 ---------- 

14 name : str 

15 Label of the model 

16 model_like : model_like 

17 A continuous output regression model or pipeline. It must have a 

18 `predict` function that returns array containing the predicted outcomes for each sample. 

19 """ 

20 

21 def __init__(self, name: str, model_like=None, tags=None): 

22 super().__init__("REGRESSION", ["predict"], ["predict"], name, model_like, tags) 

23 

24 

25class DummyRegression: 

26 """Class wrapper around regression model predictions 

27 

28 This class can be used when a regression model is not available but its outputs are. 

29 The output include the array containing the predicted class labels and/or the array 

30 containing the class labels probabilities. 

31 Wrap the outputs with this class into a dummy classifier and pass it as 

32 the model to `RegressionModel`. 

33 

34 Parameters 

35 ---------- 

36 predict_output : array 

37 Array containing the output of a model's "predict" method 

38 """ 

39 

40 def __init__(self, name: str, predict_output=None, tags=None): 

41 self.predict_output = predict_output 

42 self.name = name 

43 self.tags = tags 

44 

45 def predict(self, X=None): 

46 return self.predict_output