Source code for mmlspark.cognitive.NER

# 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 NER(ComplexParamsMixin, JavaMLReadable, JavaMLWritable, JavaTransformer): """ Args: concurrency (int): max number of concurrent calls (default: 1) concurrentTimeout (double): max number seconds to wait on futures if concurrency >= 1 (default: 100.0) errorCol (str): column to hold http errors (default: [self.uid]_error) handler (object): Which strategy to use when handling requests (default: UserDefinedFunction(<function2>,StringType,None)) language (object): the language code of the text (optional for some services) (default: ServiceParamData(None,Some(List(en)))) outputCol (str): The name of the output column (default: [self.uid]_output) subscriptionKey (object): the API key to use text (object): the text in the request body (default: ServiceParamData(Some(Right(text)),None)) timeout (double): number of seconds to wait before closing the connection (default: 60.0) url (str): Url of the service """ @keyword_only def __init__(self, concurrency=1, concurrentTimeout=100.0, errorCol=None, handler=None, language=None, outputCol=None, subscriptionKey=None, text=None, timeout=60.0, url=None): super(NER, self).__init__() self._java_obj = self._new_java_obj("com.microsoft.ml.spark.cognitive.NER") self._cache = {} self.concurrency = Param(self, "concurrency", "concurrency: max number of concurrent calls (default: 1)") self._setDefault(concurrency=1) self.concurrentTimeout = Param(self, "concurrentTimeout", "concurrentTimeout: max number seconds to wait on futures if concurrency >= 1 (default: 100.0)") self._setDefault(concurrentTimeout=100.0) self.errorCol = Param(self, "errorCol", "errorCol: column to hold http errors (default: [self.uid]_error)") self._setDefault(errorCol=self.uid + "_error") self.handler = Param(self, "handler", "handler: Which strategy to use when handling requests (default: UserDefinedFunction(<function2>,StringType,None))", generateTypeConverter("handler", self._cache, complexTypeConverter)) self.language = Param(self, "language", "language: the language code of the text (optional for some services) (default: ServiceParamData(None,Some(List(en))))") self.outputCol = Param(self, "outputCol", "outputCol: The name of the output column (default: [self.uid]_output)") self._setDefault(outputCol=self.uid + "_output") self.subscriptionKey = Param(self, "subscriptionKey", "subscriptionKey: the API key to use") self.text = Param(self, "text", "text: the text in the request body (default: ServiceParamData(Some(Right(text)),None))") self.timeout = Param(self, "timeout", "timeout: number of seconds to wait before closing the connection (default: 60.0)") self._setDefault(timeout=60.0) self.url = Param(self, "url", "url: Url of the service") if hasattr(self, "_input_kwargs"): kwargs = self._input_kwargs else: kwargs = self.__init__._input_kwargs self.setParams(**kwargs)
[docs] @keyword_only def setParams(self, concurrency=1, concurrentTimeout=100.0, errorCol=None, handler=None, language=None, outputCol=None, subscriptionKey=None, text=None, timeout=60.0, url=None): """ Set the (keyword only) parameters Args: concurrency (int): max number of concurrent calls (default: 1) concurrentTimeout (double): max number seconds to wait on futures if concurrency >= 1 (default: 100.0) errorCol (str): column to hold http errors (default: [self.uid]_error) handler (object): Which strategy to use when handling requests (default: UserDefinedFunction(<function2>,StringType,None)) language (object): the language code of the text (optional for some services) (default: ServiceParamData(None,Some(List(en)))) outputCol (str): The name of the output column (default: [self.uid]_output) subscriptionKey (object): the API key to use text (object): the text in the request body (default: ServiceParamData(Some(Right(text)),None)) timeout (double): number of seconds to wait before closing the connection (default: 60.0) url (str): Url of the service """ if hasattr(self, "_input_kwargs"): kwargs = self._input_kwargs else: kwargs = self.__init__._input_kwargs return self._set(**kwargs)
[docs] def getConcurrency(self): """ Returns: int: max number of concurrent calls (default: 1) """ return self.getOrDefault(self.concurrency)
[docs] def getConcurrentTimeout(self): """ Returns: double: max number seconds to wait on futures if concurrency >= 1 (default: 100.0) """ return self.getOrDefault(self.concurrentTimeout)
[docs] def getErrorCol(self): """ Returns: str: column to hold http errors (default: [self.uid]_error) """ return self.getOrDefault(self.errorCol)
[docs] def getHandler(self): """ Returns: object: Which strategy to use when handling requests (default: UserDefinedFunction(<function2>,StringType,None)) """ return self._cache.get("handler", None)
[docs] def getLanguage(self): """ Returns: object: the language code of the text (optional for some services) (default: ServiceParamData(None,Some(List(en)))) """ return self._cache.get("language", None)
[docs] def getOutputCol(self): """ Returns: str: The name of the output column (default: [self.uid]_output) """ return self.getOrDefault(self.outputCol)
[docs] def getSubscriptionKey(self): """ Returns: object: the API key to use """ return self._cache.get("subscriptionKey", None)
[docs] def getText(self): """ Returns: object: the text in the request body (default: ServiceParamData(Some(Right(text)),None)) """ return self._cache.get("text", None)
[docs] def getTimeout(self): """ Returns: double: number of seconds to wait before closing the connection (default: 60.0) """ return self.getOrDefault(self.timeout)
[docs] def getUrl(self): """ Returns: str: Url of the service """ return self.getOrDefault(self.url)
[docs] def setConcurrency(self, value): """ Args: concurrency: max number of concurrent calls (default: 1) """ self._set(concurrency=value) return self
[docs] def setConcurrentTimeout(self, value): """ Args: concurrentTimeout: max number seconds to wait on futures if concurrency >= 1 (default: 100.0) """ self._set(concurrentTimeout=value) return self
[docs] def setErrorCol(self, value): """ Args: errorCol: column to hold http errors (default: [self.uid]_error) """ self._set(errorCol=value) return self
[docs] def setHandler(self, value): """ Args: handler: Which strategy to use when handling requests (default: UserDefinedFunction(<function2>,StringType,None)) """ self._set(handler=value) return self
[docs] def setLanguage(self, value): """ Args: language: the language code of the text (optional for some services) (default: ServiceParamData(None,Some(List(en)))) """ self._java_obj = self._java_obj.setLanguage(value) return self
[docs] def setLanguageCol(self, value): """ Args: language: the language code of the text (optional for some services) (default: ServiceParamData(None,Some(List(en)))) """ self._java_obj = self._java_obj.setLanguageCol(value) return self
[docs] def setOutputCol(self, value): """ Args: outputCol: The name of the output column (default: [self.uid]_output) """ self._set(outputCol=value) return self
[docs] def setSubscriptionKey(self, value): """ Args: subscriptionKey: the API key to use """ self._java_obj = self._java_obj.setSubscriptionKey(value) return self
[docs] def setSubscriptionKeyCol(self, value): """ Args: subscriptionKey: the API key to use """ self._java_obj = self._java_obj.setSubscriptionKeyCol(value) return self
[docs] def setText(self, value): """ Args: text: the text in the request body (default: ServiceParamData(Some(Right(text)),None)) """ self._java_obj = self._java_obj.setText(value) return self
[docs] def setTextCol(self, value): """ Args: text: the text in the request body (default: ServiceParamData(Some(Right(text)),None)) """ self._java_obj = self._java_obj.setTextCol(value) return self
[docs] def setTimeout(self, value): """ Args: timeout: number of seconds to wait before closing the connection (default: 60.0) """ self._set(timeout=value) return self
[docs] def setUrl(self, value): """ Args: url: Url of the service """ self._set(url=value) return self
[docs] def setLocation(self, value): self._java_obj = self._java_obj.setLocation(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.cognitive.NER"
@staticmethod def _from_java(java_stage): module_name=NER.__module__ module_name=module_name.rsplit(".", 1)[0] + ".NER" return from_java(java_stage, module_name)