oracle-ads 2.13.9rc0__py3-none-any.whl → 2.13.9rc1__py3-none-any.whl

ads/feature_engineering/exceptions.py

@@ -0,0 +1,40 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*--
+
+# Copyright (c) 2021, 2022 Oracle and/or its affiliates.
+# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
+
+
+class InvalidFeatureType(TypeError):
+    def __init__(self, tname: str):
+        super().__init__(f"Type {tname} is not a sublcass of FeatureType.")
+
+
+class TypeAlreadyRegistered(TypeError):
+    def __init__(self, tname: str):
+        super().__init__(f"Type {tname} already registered.")
+
+
+class TypeAlreadyAdded(TypeError):
+    def __init__(self, tname: str):
+        super().__init__(f"Type {tname} is already added.")
+
+
+class TypeNotFound(TypeError):
+    def __init__(self, tname: str):
+        super().__init__(f"Type {tname} is not found.")
+
+
+class NameAlreadyRegistered(NameError):
+    def __init__(self, name: str):
+        super().__init__(f"Type with name {name} already registered.")
+
+
+class WarningAlreadyExists(ValueError):
+    def __init__(self, name: str):
+        super().__init__(f"Warning {name} already exists.")
+
+
+class WarningNotFound(ValueError):
+    def __init__(self, name: str):
+        super().__init__(f"Warning {name} is not found.")

ads/feature_engineering/feature_type/__init__.py

@@ -0,0 +1,133 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*--
+
+# Copyright (c) 2021, 2022 Oracle and/or its affiliates.
+# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
+
+"""
+Address
+    Type representing address.
+Boolean
+    Type representing binary values True/False.
+Category
+    Type representing discrete unordered values.
+Constant
+    Type representing constant values.
+Continuous
+    Type representing continuous values.
+CreditCard
+    Type representing credit card numbers.
+DateTime
+    Type representing date and/or time.
+Document
+    Type representing document values.
+Discrete
+    Type representing discrete values.
+FeatureType
+    Base class for all feature types.
+GIS
+    Type representing geographic information.
+Integer
+    Type representing integer values.
+IpAddress
+    Type representing IP Address.
+IpAddressV4
+    Type representing IP Address V4.
+IpAddressV6
+    Type representing IP Address V6.
+LatLong
+    Type representing longitude and latitute.
+Object
+    Type representing object.
+Ordinal
+    Type representing ordered values.
+PhoneNumber
+    Type representing phone numbers.
+String
+    Type representing string values.
+Tag
+    Free form tag.
+Text
+    Type representing text values.
+ZipCode
+    Type representing postal code.
+Unknown
+    Type representing third-party dtypes.
+"""
+
+from ads.feature_engineering.feature_type.address import Address
+from ads.feature_engineering.feature_type.boolean import Boolean
+from ads.feature_engineering.feature_type.category import Category
+from ads.feature_engineering.feature_type.constant import Constant
+from ads.feature_engineering.feature_type.continuous import Continuous
+from ads.feature_engineering.feature_type.creditcard import CreditCard
+from ads.feature_engineering.feature_type.datetime import DateTime
+from ads.feature_engineering.feature_type.document import Document
+from ads.feature_engineering.feature_type.discrete import Discrete
+from ads.feature_engineering.feature_type.base import FeatureType
+from ads.feature_engineering.feature_type.gis import GIS
+from ads.feature_engineering.feature_type.integer import Integer
+from ads.feature_engineering.feature_type.ip_address import IpAddress
+from ads.feature_engineering.feature_type.ip_address_v4 import IpAddressV4
+from ads.feature_engineering.feature_type.ip_address_v6 import IpAddressV6
+from ads.feature_engineering.feature_type.lat_long import LatLong
+from ads.feature_engineering.feature_type.object import Object
+from ads.feature_engineering.feature_type.ordinal import Ordinal
+from ads.feature_engineering.feature_type.phone_number import PhoneNumber
+from ads.feature_engineering.feature_type.string import String
+from ads.feature_engineering.feature_type.base import Tag
+from ads.feature_engineering.feature_type.text import Text
+from ads.feature_engineering.feature_type.zip_code import ZipCode
+from ads.feature_engineering.feature_type.unknown import Unknown
+from ads.feature_engineering.feature_type.handler import warnings as w
+from ads.feature_engineering.feature_type.adsstring.string import ADSString
+
+Address.warning.register("missing_values", w.missing_values_handler)
+
+Boolean.warning.register("missing_values", w.missing_values_handler)
+
+Category.warning.register("missing_values", w.missing_values_handler)
+Category.warning.register("high_cardinality", w.high_cardinality_handler)
+
+Constant.warning.register("missing_values", w.missing_values_handler)
+
+Continuous.warning.register("missing_values", w.missing_values_handler)
+Continuous.warning.register("zeros", w.zeros_handler)
+Continuous.warning.register("skew_handler", w.skew_handler)
+
+CreditCard.warning.register("missing_values", w.missing_values_handler)
+CreditCard.warning.register("high_cardinality", w.high_cardinality_handler)
+
+DateTime.warning.register("missing_values", w.missing_values_handler)
+DateTime.warning.register("high_cardinality", w.high_cardinality_handler)
+
+Document.warning.register("missing_values", w.missing_values_handler)
+
+GIS.warning.register("missing_values", w.missing_values_handler)
+
+Integer.warning.register("missing_values", w.missing_values_handler)
+Integer.warning.register("zeros", w.zeros_handler)
+
+IpAddress.warning.register("missing_values", w.missing_values_handler)
+
+IpAddressV4.warning.register("missing_values", w.missing_values_handler)
+
+IpAddressV6.warning.register("missing_values", w.missing_values_handler)
+
+LatLong.warning.register("missing_values", w.missing_values_handler)
+
+Object.warning.register("missing_values", w.missing_values_handler)
+Object.warning.register("high_cardinality", w.high_cardinality_handler)
+
+Ordinal.warning.register("missing_values", w.missing_values_handler)
+
+PhoneNumber.warning.register("missing_values", w.missing_values_handler)
+PhoneNumber.warning.register("high_cardinality", w.high_cardinality_handler)
+
+String.warning.register("missing_values", w.missing_values_handler)
+String.warning.register("high_cardinality", w.high_cardinality_handler)
+
+Text.warning.register("missing_values", w.missing_values_handler)
+
+ZipCode.warning.register("missing_values", w.missing_values_handler)
+ZipCode.warning.register("high_cardinality", w.high_cardinality_handler)

ads/feature_engineering/feature_type/address.py

@@ -0,0 +1,184 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*--
+
+# Copyright (c) 2021 Oracle and/or its affiliates.
+# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
+
+"""
+The module that represents an Address feature type.
+
+Classes:
+    Address
+        The Address feature type.
+"""
+import matplotlib.pyplot as plt
+import pandas as pd
+import re
+from ads.feature_engineering.feature_type.string import String
+from ads.feature_engineering.utils import (
+    _count_unique_missing,
+    _to_lat_long,
+    _plot_gis_scatter,
+    _zip_code,
+)
+from ads.feature_engineering import schema
+
+PATTERN = re.compile(
+    r"\d{1,5} [\w\s]{1,30}(?:street|st(?:\s|\.)+|avenue|ave(?:\s|\.)+|road|rd(?:\s|\.)+|highway|hwy(?:\s|\.)+|square|sq(?:\s|\.)+|trail|trl(?:\s|\.)+|drive|dr(?:\s|\.)+|court|ct(?:\s|\.)+|park|parkway|pkwy(?:\s|\.)+|circle|cir(?:\s|\.)+|boulevard|blvd(?:\s|\.)+|island|port|view|parkways)(?:suite\s?\d+|apt\.?\s?\d+|ste\.?\s?\d+)?[\w\s,]{1,30}\d{5}\W?(?=\s|$)",
+    re.IGNORECASE,
+)
+
+
+def default_handler(data: pd.Series, *args, **kwargs) -> pd.Series:
+    """Processes given data and indicates if the data matches requirements.
+
+    Parameters
+    ----------
+    data: pd.Series
+        The data to process.
+
+    Returns
+    -------
+    :class:`pandas.Series`
+        The logical list indicating if the data matches requirements.
+    """
+
+    def _is_address(x):
+        return (
+            not pd.isnull(x)
+            and isinstance(x, str)
+            and PATTERN.match(str(x)) is not None
+        )
+
+    return data.apply(lambda x: True if _is_address(x) else False)
+
+
+class Address(String):
+    """
+    Type representing address.
+
+    Attributes
+    ----------
+    description: str
+        The feature type description.
+    name: str
+        The feature type name.
+    warning: FeatureWarning
+        Provides functionality to register warnings and invoke them.
+    validator
+        Provides functionality to register validators and invoke them.
+
+    Methods
+    --------
+    feature_stat(x: pd.Series) -> pd.DataFrame
+        Generates feature statistics.
+    feature_plot(x: pd.Series) -> plt.Axes
+        Shows the location of given address on map base on zip code.
+
+    Example
+    -------
+    >>> from ads.feature_engineering.feature_type.address import Address
+    >>> import pandas as pd
+    >>> address = pd.Series(['1 Miller Drive, New York, NY 12345',
+                            '1 Berkeley Street, Boston, MA 67891',
+                            '54305 Oxford Street, Seattle, WA 95132',
+                            ''])
+    >>> Address.validator.is_address(address)
+    0     True
+    1     True
+    2     True
+    3    False
+    dtype: bool
+    """
+
+    description = "Type representing address."
+
+    @staticmethod
+    def feature_stat(x: pd.Series) -> pd.DataFrame:
+        """Generates feature statistics.
+
+        Feature statistics include (total)count, unique(count) and missing(count).
+
+        Examples
+        --------
+        >>> address = pd.Series(['1 Miller Drive, New York, NY 12345',
+                      '1 Berkeley Street, Boston, MA 67891',
+                      '54305 Oxford Street, Seattle, WA 95132',
+                      ''],
+                   name='address')
+        >>> address.ads.feature_type = ['address']
+        >>> address.ads.feature_stat()
+            Metric  Value
+        0	count	4
+        1	unique	3
+        2	missing	1
+
+        Returns
+        -------
+        :class:`pandas.DataFrame`
+            Summary statistics of the Series provided.
+        """
+        return _count_unique_missing(x)
+
+    @staticmethod
+    def feature_plot(x: pd.Series) -> plt.Axes:
+        """
+        Shows the location of given address on map base on zip code.
+
+        Examples
+        --------
+        >>> address = pd.Series(['1 Miller Drive, New York, NY 12345',
+                      '1 Berkeley Street, Boston, MA 67891',
+                      '54305 Oxford Street, Seattle, WA 95132',
+                      ''],
+                   name='address')
+        >>> address.ads.feature_type = ['address']
+        >>> address.ads.feature_plot()
+        Returns
+        -------
+        matplotlib.axes._subplots.AxesSubplot
+            Plot object for the series based on the Address feature type.
+        """
+
+        def _get_zipcode(n):
+            return re.findall(r"\D(\d{5})", n)[-1]
+
+        gis = _to_lat_long(x.loc[default_handler(x)].apply(_get_zipcode), _zip_code())
+        if len(gis.index):
+            return _plot_gis_scatter(gis, "longitude", "latitude")
+
+    @classmethod
+    def feature_domain(cls, x: pd.Series) -> schema.Domain:
+        """
+        Generate the domain of the data of this feature type.
+
+        Examples
+        --------
+        >>> address = pd.Series(['1 Miller Drive, New York, NY 12345',
+                      '1 Berkeley Street, Boston, MA 67891',
+                      '54305 Oxford Street, Seattle, WA 95132',
+                      ''],
+                   name='address')
+        >>> address.ads.feature_type = ['address']
+        >>> address.ads.feature_domain()
+        constraints: []
+        stats:
+            count: 4
+            missing: 1
+            unique: 3
+        values: Address
+
+        Returns
+        -------
+        ads.feature_engineering.schema.Domain
+            Domain based on the Address feature type.
+        """
+
+        return schema.Domain(
+            cls.__name__,
+            cls.feature_stat(x).to_dict()[x.name],
+            [],
+        )
+
+
+Address.validator.register("is_address", default_handler)

ads/feature_engineering/feature_type/adsstring/__init__.py

@@ -0,0 +1,5 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*--
+
+# Copyright (c) 2021, 2022 Oracle and/or its affiliates.
+# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/

ads/feature_engineering/feature_type/adsstring/common_regex_mixin.py

@@ -0,0 +1,164 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*--
+
+# Copyright (c) 2021, 2022 Oracle and/or its affiliates.
+# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
+
+import re
+from typing import List, Union, Dict
+
+
+class CommonRegex(object):
+
+    regexes = {
+        "date": re.compile(
+            r"(?:(?<!\:)(?<!\:\d)[0-3]?\d(?:st|nd|rd|th)?\s+(?:of\s+)?(?:jan\.?|january|feb\.?|february|mar\.?|march|apr\.?|april|may|jun\.?|june|jul\.?|july|aug\.?|august|sep\.?|september|oct\.?|october|nov\.?|november|dec\.?|december)|(?:jan\.?|january|feb\.?|february|mar\.?|march|apr\.?|april|may|jun\.?|june|jul\.?|july|aug\.?|august|sep\.?|september|oct\.?|october|nov\.?|november|dec\.?|december)\s+(?<!\:)(?<!\:\d)[0-3]?\d(?:st|nd|rd|th)?)(?:\,)?\s*(?:\d{4})?|[0-3]?\d[-\./][0-3]?\d[-\./]\d{2,4}|\d{2,4}[-\./][0-3]?\d[-\./][0-3]?\d",
+            re.IGNORECASE,
+        ),
+        "time": re.compile(
+            r"\d{1,2}:\d{2} ?(?:[ap]\.?m\.?)?|\d[ap]\.?m\.?", re.IGNORECASE
+        ),
+        "phone_number_US": re.compile(
+            r"((?:(?<![\d-])(?:\+?\d{1,3}[-.\s*]?)?(?:\(?\d{3}\)?[-.\s*]?)?\d{3}[-.\s*]?\d{4}(?![\d-]))|(?:(?<![\d-])(?:(?:\(\+?\d{2}\))|(?:\+?\d{2}))\s*\d{2}\s*\d{3}\s*\d{4}(?![\d-])))"
+        ),
+        "phone_number_US_with_ext": re.compile(
+            r"((?:(?:\+?1\s*(?:[.-]\s*)?)?(?:\(\s*(?:[2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9])\s*\)|(?:[2-9]1[02-9]|[2-9][02-8]1|[2-9][02-8][02-9]))\s*(?:[.-]\s*)?)?(?:[2-9]1[02-9]|[2-9][02-9]1|[2-9][02-9]{2})\s*(?:[.-]\s*)?(?:[0-9]{4})(?:\s*(?:#|x\.?|ext\.?|extension)\s*(?:\d+)?))",
+            re.IGNORECASE,
+        ),
+        "link": re.compile(
+            r'(?i)((?:https?://|www\d{0,3}[.])?[a-z0-9.\-]+[.](?:(?:international)|(?:construction)|(?:contractors)|(?:enterprises)|(?:photography)|(?:immobilien)|(?:management)|(?:technology)|(?:directory)|(?:education)|(?:equipment)|(?:institute)|(?:marketing)|(?:solutions)|(?:builders)|(?:clothing)|(?:computer)|(?:democrat)|(?:diamonds)|(?:graphics)|(?:holdings)|(?:lighting)|(?:plumbing)|(?:training)|(?:ventures)|(?:academy)|(?:careers)|(?:company)|(?:domains)|(?:florist)|(?:gallery)|(?:guitars)|(?:holiday)|(?:kitchen)|(?:recipes)|(?:shiksha)|(?:singles)|(?:support)|(?:systems)|(?:agency)|(?:berlin)|(?:camera)|(?:center)|(?:coffee)|(?:estate)|(?:kaufen)|(?:luxury)|(?:monash)|(?:museum)|(?:photos)|(?:repair)|(?:social)|(?:tattoo)|(?:travel)|(?:viajes)|(?:voyage)|(?:build)|(?:cheap)|(?:codes)|(?:dance)|(?:email)|(?:glass)|(?:house)|(?:ninja)|(?:photo)|(?:shoes)|(?:solar)|(?:today)|(?:aero)|(?:arpa)|(?:asia)|(?:bike)|(?:buzz)|(?:camp)|(?:club)|(?:coop)|(?:farm)|(?:gift)|(?:guru)|(?:info)|(?:jobs)|(?:kiwi)|(?:land)|(?:limo)|(?:link)|(?:menu)|(?:mobi)|(?:moda)|(?:name)|(?:pics)|(?:pink)|(?:post)|(?:rich)|(?:ruhr)|(?:sexy)|(?:tips)|(?:wang)|(?:wien)|(?:zone)|(?:biz)|(?:cab)|(?:cat)|(?:ceo)|(?:com)|(?:edu)|(?:gov)|(?:int)|(?:mil)|(?:net)|(?:onl)|(?:org)|(?:pro)|(?:red)|(?:tel)|(?:uno)|(?:xxx)|(?:ac)|(?:ad)|(?:ae)|(?:af)|(?:ag)|(?:ai)|(?:al)|(?:am)|(?:an)|(?:ao)|(?:aq)|(?:ar)|(?:as)|(?:at)|(?:au)|(?:aw)|(?:ax)|(?:az)|(?:ba)|(?:bb)|(?:bd)|(?:be)|(?:bf)|(?:bg)|(?:bh)|(?:bi)|(?:bj)|(?:bm)|(?:bn)|(?:bo)|(?:br)|(?:bs)|(?:bt)|(?:bv)|(?:bw)|(?:by)|(?:bz)|(?:ca)|(?:cc)|(?:cd)|(?:cf)|(?:cg)|(?:ch)|(?:ci)|(?:ck)|(?:cl)|(?:cm)|(?:cn)|(?:co)|(?:cr)|(?:cu)|(?:cv)|(?:cw)|(?:cx)|(?:cy)|(?:cz)|(?:de)|(?:dj)|(?:dk)|(?:dm)|(?:do)|(?:dz)|(?:ec)|(?:ee)|(?:eg)|(?:er)|(?:es)|(?:et)|(?:eu)|(?:fi)|(?:fj)|(?:fk)|(?:fm)|(?:fo)|(?:fr)|(?:ga)|(?:gb)|(?:gd)|(?:ge)|(?:gf)|(?:gg)|(?:gh)|(?:gi)|(?:gl)|(?:gm)|(?:gn)|(?:gp)|(?:gq)|(?:gr)|(?:gs)|(?:gt)|(?:gu)|(?:gw)|(?:gy)|(?:hk)|(?:hm)|(?:hn)|(?:hr)|(?:ht)|(?:hu)|(?:id)|(?:ie)|(?:il)|(?:im)|(?:in)|(?:io)|(?:iq)|(?:ir)|(?:is)|(?:it)|(?:je)|(?:jm)|(?:jo)|(?:jp)|(?:ke)|(?:kg)|(?:kh)|(?:ki)|(?:km)|(?:kn)|(?:kp)|(?:kr)|(?:kw)|(?:ky)|(?:kz)|(?:la)|(?:lb)|(?:lc)|(?:li)|(?:lk)|(?:lr)|(?:ls)|(?:lt)|(?:lu)|(?:lv)|(?:ly)|(?:ma)|(?:mc)|(?:md)|(?:me)|(?:mg)|(?:mh)|(?:mk)|(?:ml)|(?:mm)|(?:mn)|(?:mo)|(?:mp)|(?:mq)|(?:mr)|(?:ms)|(?:mt)|(?:mu)|(?:mv)|(?:mw)|(?:mx)|(?:my)|(?:mz)|(?:na)|(?:nc)|(?:ne)|(?:nf)|(?:ng)|(?:ni)|(?:nl)|(?:no)|(?:np)|(?:nr)|(?:nu)|(?:nz)|(?:om)|(?:pa)|(?:pe)|(?:pf)|(?:pg)|(?:ph)|(?:pk)|(?:pl)|(?:pm)|(?:pn)|(?:pr)|(?:ps)|(?:pt)|(?:pw)|(?:py)|(?:qa)|(?:re)|(?:ro)|(?:rs)|(?:ru)|(?:rw)|(?:sa)|(?:sb)|(?:sc)|(?:sd)|(?:se)|(?:sg)|(?:sh)|(?:si)|(?:sj)|(?:sk)|(?:sl)|(?:sm)|(?:sn)|(?:so)|(?:sr)|(?:st)|(?:su)|(?:sv)|(?:sx)|(?:sy)|(?:sz)|(?:tc)|(?:td)|(?:tf)|(?:tg)|(?:th)|(?:tj)|(?:tk)|(?:tl)|(?:tm)|(?:tn)|(?:to)|(?:tp)|(?:tr)|(?:tt)|(?:tv)|(?:tw)|(?:tz)|(?:ua)|(?:ug)|(?:uk)|(?:us)|(?:uy)|(?:uz)|(?:va)|(?:vc)|(?:ve)|(?:vg)|(?:vi)|(?:vn)|(?:vu)|(?:wf)|(?:ws)|(?:ye)|(?:yt)|(?:za)|(?:zm)|(?:zw))(?:/[^\s()<>]+[^\s`!()\[\]{};:\'".,<>?\xab\xbb\u201c\u201d\u2018\u2019])?)',
+            re.IGNORECASE,
+        ),
+        "email": re.compile(
+            r"([a-z0-9!#$%&\'*+\/=?^_`{|.}~-]+@(?:[a-z0-9](?:[a-z0-9-]*[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]*[a-z0-9])?)",
+            re.IGNORECASE,
+        ),
+        "ip": re.compile(
+            r"(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)",
+            re.IGNORECASE,
+        ),
+        "ipv6": re.compile(
+            r"\s*(?!.*::.*::)(?:(?!:)|:(?=:))(?:[0-9a-f]{0,4}(?:(?<=::)|(?<!::):)){6}(?:[0-9a-f]{0,4}(?:(?<=::)|(?<!::):)[0-9a-f]{0,4}(?:(?<=::)|(?<!:)|(?<=:)(?<!::):)|(?:25[0-4]|2[0-4]\d|1\d\d|[1-9]?\d)(?:\.(?:25[0-4]|2[0-4]\d|1\d\d|[1-9]?\d)){3})\s*",
+            re.VERBOSE | re.IGNORECASE | re.DOTALL,
+        ),
+        "price": re.compile(
+            r"[$]\s?[+-]?[0-9]{1,3}(?:(?:,?[0-9]{3}))*(?:\.[0-9]{1,2})?"
+        ),
+        "credit_card": re.compile(r"((?:(?:\d{4}[- ]?){3}\d{4}|\d{15,16}))(?![\d])"),
+        "address": re.compile(
+            r"\d{1,5} [\w\s]{1,30}(?:street|st|crescent|avenue|ave|road|rd|highway|hwy|square|sq|trail|trl|drive|dr|court|ct|park|parkway|pkwy|circle|cir|boulevard|blvd)\W?(?=\s|$)",
+            re.IGNORECASE,
+        ),
+        "zip_code": re.compile(r"\b\d{5}(?:[-\s]\d{4})?\b"),
+        "po_box": re.compile(r"P\.? ?O\.? Box \d+", re.IGNORECASE),
+        "ssn": re.compile(r"(?!666|000|9\d{2})\d{3}[- ](?!00)\d{2}[- ](?!0{4})\d{4}"),
+        "address_with_zip": re.compile(
+            r"\d{1,5} [\w\s]{1,30}(?:street|st(?:\s|\.)+|avenue|ave(?:\s|\.)+|road|rd(?:\s|\.)+|highway|hwy(?:\s|\.)+|square|sq(?:\s|\.)+|trail|trl(?:\s|\.)+|drive|dr(?:\s|\.)+|court|ct(?:\s|\.)+|park|parkway|pkwy(?:\s|\.)+|circle|cir(?:\s|\.)+|boulevard|blvd(?:\s|\.)+|island|port|view|parkways)(?:suite\s?\d+|apt\.?\s?\d+|ste\.?\s?\d+)?[\w\s,]{1,30}\d{5}\W?(?=\s|$)",
+            re.IGNORECASE,
+        ),
+    }
+
+    class regex:
+        def __init__(self, obj, regex):
+            self.obj = obj
+            self.regex = regex
+
+        def __call__(self, *args):
+            def regex_method(text=None):
+                return [x.strip() for x in self.regex.findall(text or self.obj.text)]
+
+            return regex_method
+
+    def __init__(self, text=""):
+        self.text = text
+
+        for k, v in CommonRegex.regexes.items():
+            setattr(self, k, CommonRegex.regex(self, v)(self))
+
+        if text:
+            for key in CommonRegex.regexes.keys():
+                method = getattr(self, key)
+                setattr(self, key, method())
+
+
+class CommonRegexMixin(object):
+
+    redact_map = {key: "[" + key.upper() + "]" for key in CommonRegex.regexes.keys()}
+
+    def __init__(self):
+        self.parsed = CommonRegex(self.string)
+
+    @property
+    def date(self):
+        return self.parsed.date
+
+    @property
+    def time(self):
+        return self.parsed.time
+
+    @property
+    def phone_number_US(self):
+        return self.parsed.phone_number_US + self.parsed.phone_number_US_with_ext
+
+    @property
+    def link(self):
+        return self.parsed.link
+
+    @property
+    def email(self):
+        return self.parsed.email
+
+    @property
+    def ip(self):
+        return self.parsed.ip + self.parsed.ipv6
+
+    @property
+    def price(self):
+        return self.parsed.price
+
+    @property
+    def credit_card(self):
+        return self.parsed.credit_card
+
+    @property
+    def address(self):
+        return self.parsed.address + self.parsed.address_with_zip
+
+    @property
+    def zip_code(self):
+        return self.parsed.zip_code
+
+    @property
+    def ssn(self):
+        return self.parsed.ssn
+
+    def redact(self, fields: Union[List[str], Dict[str, str]]) -> str:
+        """Remove personal information in a string.
+        For example, "Jane's phone number is 123-456-7890" is turned into "Jane's phone number is [phone_number_US]."
+
+        Parameters
+        ----------
+        fields: (list(str) | dict)
+            either a list of fields to redact, e.g. ['email', 'phone_number_US'], in which case the redacted text is replaced
+            with capitalized word like [EMAIL] or [PHONE_NUMBER_US_WITH_EXT], or a dictionary where key is a field to redact and value
+            is the replacement text, e.g., {'email': 'HIDDEN_EMAIL'}.
+
+        Returns
+        -------
+        str
+            redacted string
+        """
+        if isinstance(fields, list):
+            redact_map = {
+                field: self.redact_map[field]
+                for field in fields
+                if field in self.redact_map
+            }
+        else:
+            redact_map = {
+                k: "[" + v + "]" for k, v in fields.items() if k in self.redact_map
+            }
+        _string = self.string
+        for k, v in redact_map.items():
+            _string = re.sub(CommonRegex.regexes[k], v, _string)
+        return _string

ads/feature_engineering/feature_type/adsstring/oci_language.py

@@ -0,0 +1,93 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*--
+
+# Copyright (c) 2021, 2022 Oracle and/or its affiliates.
+# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
+
+import json
+from typing import Dict, List
+
+import oci.ai_language
+import pandas as pd
+from ads.common import auth as authutil
+from ads.common import oci_client
+
+
+class OCILanguage(object):  # pragma: no cover
+    """Defines the OCILanguage plugin for ADSString built on top of the OCI Language Services.
+
+    Example
+    -------
+    >>> ADSString.plugin_register(OCILanguage)
+    >>> s = ADSString("This movie is awesome.")
+    >>> s.absa
+    >>> s.text_classification
+    >>> s.ner
+    >>> s.language_dominant
+    """
+
+    def __init__(self, auth=None):
+        auth = auth if auth else authutil.default_signer()
+        self.ai_client = oci_client.OCIClientFactory(**auth).ai_language
+
+    @property
+    def ner(self) -> List[Dict]:
+        """Detects named entites in the text."""
+        output = self.ai_client.batch_detect_language_entities(
+            oci.ai_language.models.BatchDetectLanguageEntitiesDetails(
+                documents=[
+                    oci.ai_language.models.TextDocument(key="1", text=self.string)
+                ]
+            )
+        )
+        return json.loads(str(output.data.documents[0]))["entities"]
+
+    @property
+    def language_dominant(self) -> List[Dict]:
+        """Determines the language of the text along with ISO 639-1 language code and a probability score."""
+        output = self.ai_client.batch_detect_dominant_language(
+            oci.ai_language.models.BatchDetectDominantLanguageDetails(
+                documents=[
+                    oci.ai_language.models.DominantLanguageDocument(
+                        key="1", text=self.string
+                    )
+                ]
+            )
+        )
+        return json.loads(str(output.data.documents[0]))
+
+    @property
+    def key_phrase(self) -> List[Dict]:
+        """Extracts the most relevant words from the ADSString object and assigns them a score."""
+        output = self.ai_client.batch_detect_language_key_phrases(
+            oci.ai_language.models.BatchDetectLanguageKeyPhrasesDetails(
+                documents=[
+                    oci.ai_language.models.TextDocument(key="1", text=self.string)
+                ]
+            )
+        )
+        return json.loads(str(output.data.documents[0]))["key_phrases"]
+
+    @property
+    def absa(self) -> List[Dict]:
+        """Runs aspect-based sentiment analysis on the text to gauge teh mood or the tone of the text."""
+        output = self.ai_client.batch_detect_language_sentiments(
+            oci.ai_language.models.BatchDetectLanguageSentimentsDetails(
+                documents=[
+                    oci.ai_language.models.TextDocument(key="1", text=self.string)
+                ]
+            )
+        )
+        return json.loads(str(output.data.documents[0]))["aspects"]
+
+    @property
+    def text_classification(self) -> List[Dict]:
+        """Analyses the text and identifies categories for the content with a confidence score."""
+        output = self.ai_client.batch_detect_language_text_classification(
+            oci.ai_language.models.BatchDetectLanguageTextClassificationDetails(
+                documents=[
+                    oci.ai_language.models.TextDocument(key="1", text=self.string)
+                ]
+            )
+        )
+        return json.loads(str(output.data.documents[0]))["text_classification"]

ads/feature_engineering/feature_type/adsstring/parsers/__init__.py

@@ -0,0 +1,5 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*--
+
+# Copyright (c) 2021, 2022 Oracle and/or its affiliates.
+# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/

ads/feature_engineering/feature_type/adsstring/parsers/base.py

@@ -0,0 +1,47 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*--
+
+# Copyright (c) 2021, 2022 Oracle and/or its affiliates.
+# Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/
+
+
+class Parser:
+    @property
+    def pos(self):
+        raise NotImplementedError()
+
+    @property
+    def noun(self):
+        raise NotImplementedError()
+
+    @property
+    def adjective(self):
+        raise NotImplementedError()
+
+    @property
+    def adverb(self):
+        raise NotImplementedError()
+
+    @property
+    def verb(self):
+        raise NotImplementedError()
+
+    @property
+    def word(self):
+        raise NotImplementedError()
+
+    @property
+    def sentence(self):
+        raise NotImplementedError()
+
+    @property
+    def word_count(self):
+        raise NotImplementedError()
+
+    @property
+    def bigram(self):
+        raise NotImplementedError()
+
+    @property
+    def trigram(self):
+        raise NotImplementedError()