2015-01-28 20:14:23 -05:00
|
|
|
#
|
|
|
|
# Licensed to the Apache Software Foundation (ASF) under one or more
|
|
|
|
# contributor license agreements. See the NOTICE file distributed with
|
|
|
|
# this work for additional information regarding copyright ownership.
|
|
|
|
# The ASF licenses this file to You under the Apache License, Version 2.0
|
|
|
|
# (the "License"); you may not use this file except in compliance with
|
|
|
|
# the License. You may obtain a copy of the License at
|
|
|
|
#
|
|
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
#
|
|
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
|
|
# See the License for the specific language governing permissions and
|
|
|
|
# limitations under the License.
|
|
|
|
#
|
|
|
|
|
2016-01-29 12:22:24 -05:00
|
|
|
import sys
|
2015-01-28 20:14:23 -05:00
|
|
|
import uuid
|
2016-01-29 12:22:24 -05:00
|
|
|
from functools import wraps
|
|
|
|
|
|
|
|
if sys.version > '3':
|
|
|
|
basestring = str
|
|
|
|
|
|
|
|
from pyspark import SparkContext, since
|
|
|
|
from pyspark.mllib.common import inherit_doc
|
|
|
|
|
|
|
|
|
|
|
|
def _jvm():
|
|
|
|
"""
|
|
|
|
Returns the JVM view associated with SparkContext. Must be called
|
|
|
|
after SparkContext is initialized.
|
|
|
|
"""
|
|
|
|
jvm = SparkContext._jvm
|
|
|
|
if jvm:
|
|
|
|
return jvm
|
|
|
|
else:
|
|
|
|
raise AttributeError("Cannot load _jvm from SparkContext. Is SparkContext initialized?")
|
2015-01-28 20:14:23 -05:00
|
|
|
|
|
|
|
|
2015-02-15 23:29:26 -05:00
|
|
|
def keyword_only(func):
|
|
|
|
"""
|
|
|
|
A decorator that forces keyword arguments in the wrapped method
|
|
|
|
and saves actual input keyword arguments in `_input_kwargs`.
|
|
|
|
"""
|
|
|
|
@wraps(func)
|
|
|
|
def wrapper(*args, **kwargs):
|
|
|
|
if len(args) > 1:
|
|
|
|
raise TypeError("Method %s forces keyword arguments." % func.__name__)
|
|
|
|
wrapper._input_kwargs = kwargs
|
|
|
|
return func(*args, **kwargs)
|
|
|
|
return wrapper
|
|
|
|
|
|
|
|
|
2015-01-28 20:14:23 -05:00
|
|
|
class Identifiable(object):
|
|
|
|
"""
|
|
|
|
Object with a unique ID.
|
|
|
|
"""
|
|
|
|
|
|
|
|
def __init__(self):
|
2015-05-18 15:02:18 -04:00
|
|
|
#: A unique id for the object.
|
|
|
|
self.uid = self._randomUID()
|
2015-01-28 20:14:23 -05:00
|
|
|
|
|
|
|
def __repr__(self):
|
|
|
|
return self.uid
|
2015-05-18 15:02:18 -04:00
|
|
|
|
|
|
|
@classmethod
|
|
|
|
def _randomUID(cls):
|
|
|
|
"""
|
|
|
|
Generate a unique id for the object. The default implementation
|
|
|
|
concatenates the class name, "_", and 12 random hex chars.
|
|
|
|
"""
|
|
|
|
return cls.__name__ + "_" + uuid.uuid4().hex[12:]
|
2016-01-29 12:22:24 -05:00
|
|
|
|
|
|
|
|
|
|
|
@inherit_doc
|
|
|
|
class JavaMLWriter(object):
|
|
|
|
"""
|
|
|
|
.. note:: Experimental
|
|
|
|
|
|
|
|
Utility class that can save ML instances through their Scala implementation.
|
|
|
|
|
|
|
|
.. versionadded:: 2.0.0
|
|
|
|
"""
|
|
|
|
|
|
|
|
def __init__(self, instance):
|
|
|
|
instance._transfer_params_to_java()
|
|
|
|
self._jwrite = instance._java_obj.write()
|
|
|
|
|
|
|
|
def save(self, path):
|
|
|
|
"""Save the ML instance to the input path."""
|
|
|
|
if not isinstance(path, basestring):
|
|
|
|
raise TypeError("path should be a basestring, got type %s" % type(path))
|
|
|
|
self._jwrite.save(path)
|
|
|
|
|
|
|
|
def overwrite(self):
|
|
|
|
"""Overwrites if the output path already exists."""
|
|
|
|
self._jwrite.overwrite()
|
|
|
|
return self
|
|
|
|
|
|
|
|
def context(self, sqlContext):
|
|
|
|
"""Sets the SQL context to use for saving."""
|
|
|
|
self._jwrite.context(sqlContext._ssql_ctx)
|
|
|
|
return self
|
|
|
|
|
|
|
|
|
|
|
|
@inherit_doc
|
|
|
|
class MLWritable(object):
|
|
|
|
"""
|
|
|
|
.. note:: Experimental
|
|
|
|
|
|
|
|
Mixin for ML instances that provide JavaMLWriter.
|
|
|
|
|
|
|
|
.. versionadded:: 2.0.0
|
|
|
|
"""
|
|
|
|
|
|
|
|
def write(self):
|
|
|
|
"""Returns an JavaMLWriter instance for this ML instance."""
|
|
|
|
return JavaMLWriter(self)
|
|
|
|
|
|
|
|
def save(self, path):
|
|
|
|
"""Save this ML instance to the given path, a shortcut of `write().save(path)`."""
|
|
|
|
self.write().save(path)
|
|
|
|
|
|
|
|
|
|
|
|
@inherit_doc
|
|
|
|
class JavaMLReader(object):
|
|
|
|
"""
|
|
|
|
.. note:: Experimental
|
|
|
|
|
|
|
|
Utility class that can load ML instances through their Scala implementation.
|
|
|
|
|
|
|
|
.. versionadded:: 2.0.0
|
|
|
|
"""
|
|
|
|
|
|
|
|
def __init__(self, clazz):
|
|
|
|
self._clazz = clazz
|
|
|
|
self._jread = self._load_java_obj(clazz).read()
|
|
|
|
|
|
|
|
def load(self, path):
|
|
|
|
"""Load the ML instance from the input path."""
|
|
|
|
if not isinstance(path, basestring):
|
|
|
|
raise TypeError("path should be a basestring, got type %s" % type(path))
|
|
|
|
java_obj = self._jread.load(path)
|
|
|
|
instance = self._clazz()
|
|
|
|
instance._java_obj = java_obj
|
|
|
|
instance._resetUid(java_obj.uid())
|
|
|
|
instance._transfer_params_from_java()
|
|
|
|
return instance
|
|
|
|
|
|
|
|
def context(self, sqlContext):
|
|
|
|
"""Sets the SQL context to use for loading."""
|
|
|
|
self._jread.context(sqlContext._ssql_ctx)
|
|
|
|
return self
|
|
|
|
|
|
|
|
@classmethod
|
|
|
|
def _java_loader_class(cls, clazz):
|
|
|
|
"""
|
|
|
|
Returns the full class name of the Java ML instance. The default
|
|
|
|
implementation replaces "pyspark" by "org.apache.spark" in
|
|
|
|
the Python full class name.
|
|
|
|
"""
|
|
|
|
java_package = clazz.__module__.replace("pyspark", "org.apache.spark")
|
2016-03-16 16:49:40 -04:00
|
|
|
if clazz.__name__ in ("Pipeline", "PipelineModel"):
|
|
|
|
# Remove the last package name "pipeline" for Pipeline and PipelineModel.
|
|
|
|
java_package = ".".join(java_package.split(".")[0:-1])
|
2016-01-29 12:22:24 -05:00
|
|
|
return ".".join([java_package, clazz.__name__])
|
|
|
|
|
|
|
|
@classmethod
|
|
|
|
def _load_java_obj(cls, clazz):
|
|
|
|
"""Load the peer Java object of the ML instance."""
|
|
|
|
java_class = cls._java_loader_class(clazz)
|
|
|
|
java_obj = _jvm()
|
|
|
|
for name in java_class.split("."):
|
|
|
|
java_obj = getattr(java_obj, name)
|
|
|
|
return java_obj
|
|
|
|
|
|
|
|
|
|
|
|
@inherit_doc
|
|
|
|
class MLReadable(object):
|
|
|
|
"""
|
|
|
|
.. note:: Experimental
|
|
|
|
|
|
|
|
Mixin for instances that provide JavaMLReader.
|
|
|
|
|
|
|
|
.. versionadded:: 2.0.0
|
|
|
|
"""
|
|
|
|
|
|
|
|
@classmethod
|
|
|
|
def read(cls):
|
|
|
|
"""Returns an JavaMLReader instance for this class."""
|
|
|
|
return JavaMLReader(cls)
|
|
|
|
|
|
|
|
@classmethod
|
|
|
|
def load(cls, path):
|
|
|
|
"""Reads an ML instance from the input path, a shortcut of `read().load(path)`."""
|
|
|
|
return cls.read().load(path)
|