# Copyright (C) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See LICENSE in project root for information.
import sys
if sys.version >= '3':
basestring = str
from pyspark import SparkContext, SQLContext
from pyspark.sql import DataFrame
from pyspark.ml.param.shared import *
from pyspark import keyword_only
from pyspark.ml.util import JavaMLReadable, JavaMLWritable
from mmlspark.core.serialize.java_params_patch import *
from pyspark.ml.wrapper import JavaTransformer, JavaEstimator, JavaModel
from pyspark.ml.common import inherit_doc
from mmlspark.core.schema.Utils import *
from mmlspark.core.schema.TypeConversionUtils import generateTypeConverter, complexTypeConverter
[docs]@inherit_doc
class Timer(ComplexParamsMixin, JavaMLReadable, JavaMLWritable, JavaEstimator):
"""
Args:
disableMaterialization (bool): Whether to disable timing (so that one can turn it off for evaluation) (default: true)
logToScala (bool): Whether to output the time to the scala console (default: true)
stage (object): The stage to time
"""
@keyword_only
def __init__(self, disableMaterialization=True, logToScala=True, stage=None):
super(Timer, self).__init__()
self._java_obj = self._new_java_obj("com.microsoft.ml.spark.stages.Timer")
self._cache = {}
self.disableMaterialization = Param(self, "disableMaterialization", "disableMaterialization: Whether to disable timing (so that one can turn it off for evaluation) (default: true)")
self._setDefault(disableMaterialization=True)
self.logToScala = Param(self, "logToScala", "logToScala: Whether to output the time to the scala console (default: true)")
self._setDefault(logToScala=True)
self.stage = Param(self, "stage", "stage: The stage to time", generateTypeConverter("stage", self._cache, complexTypeConverter))
if hasattr(self, "_input_kwargs"):
kwargs = self._input_kwargs
else:
kwargs = self.__init__._input_kwargs
self.setParams(**kwargs)
[docs] @keyword_only
def setParams(self, disableMaterialization=True, logToScala=True, stage=None):
"""
Set the (keyword only) parameters
Args:
disableMaterialization (bool): Whether to disable timing (so that one can turn it off for evaluation) (default: true)
logToScala (bool): Whether to output the time to the scala console (default: true)
stage (object): The stage to time
"""
if hasattr(self, "_input_kwargs"):
kwargs = self._input_kwargs
else:
kwargs = self.__init__._input_kwargs
return self._set(**kwargs)
[docs] def getDisableMaterialization(self):
"""
Returns:
bool: Whether to disable timing (so that one can turn it off for evaluation) (default: true)
"""
return self.getOrDefault(self.disableMaterialization)
[docs] def getLogToScala(self):
"""
Returns:
bool: Whether to output the time to the scala console (default: true)
"""
return self.getOrDefault(self.logToScala)
[docs] def getStage(self):
"""
Returns:
object: The stage to time
"""
return self._cache.get("stage", None)
[docs] def setDisableMaterialization(self, value):
"""
Args:
disableMaterialization: Whether to disable timing (so that one can turn it off for evaluation) (default: true)
"""
self._set(disableMaterialization=value)
return self
[docs] def setLogToScala(self, value):
"""
Args:
logToScala: Whether to output the time to the scala console (default: true)
"""
self._set(logToScala=value)
return self
[docs] def setStage(self, value):
"""
Args:
stage: The stage to time
"""
self._set(stage=value)
return self
[docs] @classmethod
def read(cls):
""" Returns an MLReader instance for this class. """
return JavaMMLReader(cls)
[docs] @staticmethod
def getJavaPackage():
""" Returns package name String. """
return "com.microsoft.ml.spark.stages.Timer"
@staticmethod
def _from_java(java_stage):
module_name=Timer.__module__
module_name=module_name.rsplit(".", 1)[0] + ".Timer"
return from_java(java_stage, module_name)
def _create_model(self, java_model):
return TimerModel(java_model)
[docs]class TimerModel(ComplexParamsMixin, JavaModel, JavaMLWritable, JavaMLReadable):
"""
Model fitted by :class:`Timer`.
"""
[docs] @classmethod
def read(cls):
""" Returns an MLReader instance for this class. """
return JavaMMLReader(cls)
[docs] @staticmethod
def getJavaPackage():
""" Returns package name String. """
return "com.microsoft.ml.spark.stages.TimerModel"
@staticmethod
def _from_java(java_stage):
module_name=TimerModel.__module__
module_name=module_name.rsplit(".", 1)[0] + ".TimerModel"
return from_java(java_stage, module_name)