Simplify our methods/naming for inference on model/endpoints

[brifordwylie]

Right now we have a bunch of way to run predictions/inference on a model in SageWorks. This is good/fine but lets think about some simplification of the number of methods or some renaming of methods so that's it more obvious why it's different/useful to have that method.

Naming: auto_inference(), predictions(), inference_prediction(), predict(), inference()

List of current methods

• Endpoint/EndpointCore

  • auto_inference(capture=False) -> pd.DataFrame # Pulls DataFrame from FeatureSet
  • inference(eval_df: pd.DataFrame, capture_uuid: str = None) -> pd.DataFrame: # Uses passed in DataFrame
  • predict(self, eval_df: pd.DataFrame) -> pd.DataFrame: # Low level method

• Model/ModelCore

  • predictions(self, capture_uuid: str = "training_holdout") -> Union[pd.DataFrame, None]: # Retrieve predictions for model
  • inference_predictions(self, capture_uuid: str = "training_holdout") -> Union[pd.DataFrame, None]:
    """Retrieve the captured prediction results for this model"""
  • validation_predictions(self) -> Union[pd.DataFrame, None]:
    """Retrieve the captured prediction results for this model"""

• Endpoint Utils

  • predictions_using_fs(end: Endpoint) -> pd.DataFrame: # Helper method

[brifordwylie]

Code Changes
Note: Methods that are 'internal' shouldn't be used/called by outside consumers.

• Endpoint/EndpointCore

  • predict() is now internal --> _predict(). # Use auto_inference() or inference()

• Model/ModelCore

  • predictions() has been removed
  • inference_predictions() --> get_inference_predictions()
  • validation_predictions(self) is now internal --> _get_validation_predictions()