oracle-ads 2.13.7__py3-none-any.whl → 2.13.9rc0__py3-none-any.whl

ads/feature_engineering/feature_type/ip_address.py

@@ -1,144 +0,0 @@
-#!/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 IpAddress feature type.
-
-Classes:
-    IpAddress
-        The IpAddress feature type.
-"""
-import pandas as pd
-import re
-from ads.feature_engineering.feature_type.base import FeatureType
-from ads.feature_engineering.utils import _count_unique_missing
-from ads.feature_engineering import schema
-
-PATTERNV4 = 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,
-)
-
-PATTERNV6 = 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,
-)
-
-
-def default_handler(data: pd.Series, *args, **kwargs) -> pd.Series:
-    """Processes given data and indicates if the data matches requirements.
-
-    Parameters
-    ----------
-    data: :class:`pandas.Series`
-        The data to process.
-
-    Returns
-    -------
-    :class:`pandas.Series`
-        The logical list indicating if the data matches requirements.
-    """
-
-    def _is_ip_address(x):
-        return not pd.isnull(x) and (
-            PATTERNV4.match(str(x)) is not None or PATTERNV6.match(str(x)) is not None
-        )
-
-    return data.apply(lambda x: True if _is_ip_address(x) else False)
-
-
-class IpAddress(FeatureType):
-    """
-    Type representing IP 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.
-
-    Example
-    -------
-    >>> from ads.feature_engineering.feature_type.ip_address import IpAddress
-    >>> import pandas as pd
-    >>> import numpy as np
-    >>> s = pd.Series(['192.168.0.1', '2001:db8::', '', np.NaN, None], name='ip_address')
-    >>> s.ads.feature_type = ['ip_address']
-    >>> IpAddress.validator.is_ip_address(s)
-    0     True
-    1     True
-    2    False
-    3    False
-    4    False
-    Name: ip_address, dtype: bool
-    """
-
-    description = "Type representing IP Address."
-
-    @staticmethod
-    def feature_stat(x: pd.Series) -> pd.DataFrame:
-        """Generates feature statistics.
-
-        Feature statistics include (total)count, unique(count) and missing(count).
-
-        Examples
-        --------
-        >>> s = pd.Series(['2002:db8::', '192.168.0.1', '2001:db8::', '2002:db8::', np.NaN, None], name='ip_address')
-        >>> s.ads.feature_type = ['ip_address']
-        >>> s.ads.feature_stat()
-            Metric  Value
-        0	count	6
-        1	unique	2
-        2	missing	2
-
-        Returns
-        -------
-        :class:`pandas.DataFrame`
-            Summary statistics of the Series provided.
-        """
-        return _count_unique_missing(x)
-
-    @classmethod
-    def feature_domain(cls, x: pd.Series) -> schema.Domain:
-        """
-        Generate the domain of the data of this feature type.
-
-        Examples
-        --------
-        >>> s = pd.Series(['2002:db8::', '192.168.0.1', '2001:db8::', '2002:db8::', np.NaN, None], name='ip_address')
-        >>> s.ads.feature_type = ['ip_address']
-        >>> s.ads.feature_domain()
-        constraints: []
-        stats:
-            count: 6
-            missing: 2
-            unique: 3
-        values: IpAddress
-
-        Returns
-        -------
-        ads.feature_engineering.schema.Domain
-            Domain based on the IpAddress feature type.
-        """
-
-        return schema.Domain(
-            cls.__name__,
-            cls.feature_stat(x).to_dict()[x.name],
-            [],
-        )
-
-
-IpAddress.validator.register("is_ip_address", default_handler)

ads/feature_engineering/feature_type/ip_address_v4.py

@@ -1,138 +0,0 @@
-#!/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 IpAddressV4 feature type.
-
-Classes:
-    IpAddressV4
-        The IpAddressV4 feature type.
-"""
-import re
-
-import pandas as pd
-from ads.feature_engineering.feature_type.base import FeatureType
-from ads.feature_engineering.utils import _count_unique_missing
-from ads.feature_engineering import schema
-
-PATTERN = 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,
-)
-
-
-def default_handler(data: pd.Series, *args, **kwargs) -> pd.Series:
-    """Processes given data and indicates if the data matches requirements.
-
-    Parameters
-    ----------
-    data: :class:`pandas.Series`
-        The data to process.
-
-    Returns
-    -------
-    :class:`pandas.Series`
-        The logical list indicating if the data matches requirements.
-    """
-    return data.apply(
-        lambda x: True
-        if not pd.isnull(x) and PATTERN.match(str(x)) is not None
-        else False
-    )
-
-
-class IpAddressV4(FeatureType):
-    """
-    Type representing IP Address V4.
-
-    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.
-
-    Example
-    -------
-    >>> from ads.feature_engineering.feature_type.ip_address_v4 import IpAddressV4
-    >>> import pandas as pd
-    >>> import numpy as np
-    >>> s = pd.Series(['192.168.0.1', '2001:db8::', '', np.NaN, None], name='ip_address')
-    >>> s.ads.feature_type = ['ip_address_v4']
-    >>> IpAddressV4.validator.is_ip_address_v4(s)
-    0     True
-    1    False
-    2    False
-    3    False
-    4    False
-    Name: ip_address, dtype: bool
-    """
-
-    description = "Type representing IP Address V4."
-
-    @staticmethod
-    def feature_stat(x: pd.Series) -> pd.DataFrame:
-        """Generates feature statistics.
-
-        Feature statistics include (total)count, unique(count) and missing(count).
-
-        Examples
-        --------
-        >>> s = pd.Series(['192.168.0.1', '192.168.0.2', '192.168.0.3', '192.168.0.4', np.NaN, None], name='ip_address')
-        >>> s.ads.feature_type = ['ip_address_v4']
-        >>> s.ads.feature_stat()
-            Metric  Value
-        0	count	6
-        1	unique	4
-        2	missing	2
-
-        Returns
-        -------
-        :class:`pandas.DataFrame`
-            Summary statistics of the Series provided.
-        """
-        return _count_unique_missing(x)
-
-    @classmethod
-    def feature_domain(cls, x: pd.Series) -> schema.Domain:
-        """
-        Generate the domain of the data of this feature type.
-
-        Examples
-        --------
-        >>> s = pd.Series(['192.168.0.1', '192.168.0.2', '192.168.0.3', '192.168.0.4', np.NaN, None], name='ip_address_v4')
-        >>> s.ads.feature_type = ['ip_address_v4']
-        >>> s.ads.feature_domain()
-        constraints: []
-        stats:
-            count: 6
-            missing: 2
-            unique: 4
-        values: IpAddressV4
-
-        Returns
-        -------
-        ads.feature_engineering.schema.Domain
-            Domain based on the IpAddressV4 feature type.
-        """
-
-        return schema.Domain(
-            cls.__name__,
-            cls.feature_stat(x).to_dict()[x.name],
-            [],
-        )
-
-
-IpAddressV4.validator.register("is_ip_address_v4", default_handler)

ads/feature_engineering/feature_type/ip_address_v6.py

@@ -1,138 +0,0 @@
-#!/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 IpAddressV6 feature type.
-
-Classes:
-    IpAddressV6
-        The IpAddressV6 feature type.
-"""
-import re
-
-import pandas as pd
-from ads.feature_engineering.feature_type.base import FeatureType
-from ads.feature_engineering.utils import _count_unique_missing
-from ads.feature_engineering import schema
-
-PATTERN = 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,
-)
-
-
-def default_handler(data: pd.Series, *args, **kwargs) -> pd.Series:
-    """Processes given data and indicates if the data matches requirements.
-
-    Parameters
-    ----------
-    data: :class:`pandas.Series`
-        The data to process.
-
-    Returns
-    -------
-    :class:`pandas.Series`
-        The logical list indicating if the data matches requirements.
-    """
-    return data.apply(
-        lambda x: True
-        if not pd.isnull(x) and PATTERN.match(str(x)) is not None
-        else False
-    )
-
-
-class IpAddressV6(FeatureType):
-    """
-    Type representing IP Address V6.
-
-    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.
-
-    Example
-    -------
-    >>> from ads.feature_engineering.feature_type.ip_address_v6 import IpAddressV6
-    >>> import pandas as pd
-    >>> import numpy as np
-    >>> s = pd.Series(['192.168.0.1', '2001:db8::', '', np.NaN, None], name='ip_address')
-    >>> s.ads.feature_type = ['ip_address_v6']
-    >>> IpAddressV6.validator.is_ip_address_v6(s)
-    0    False
-    1     True
-    2    False
-    3    False
-    4    False
-    Name: ip_address, dtype: bool
-    """
-
-    description = "Type representing IP Address V6."
-
-    @staticmethod
-    def feature_stat(x: pd.Series) -> pd.DataFrame:
-        """Generates feature statistics.
-
-        Feature statistics include (total)count, unique(count) and missing(count).
-
-        Examples
-        --------
-        >>> s = pd.Series(['2002:db8::', '2001:db8::', '2001:db8::', '2002:db8::', np.NaN, None], name='ip_address')
-        >>> s.ads.feature_type = ['ip_address_v6']
-        >>> s.ads.feature_stat()
-            Metric  Value
-        0	count	6
-        1	unique	2
-        2	missing	2
-
-        Returns
-        -------
-        Pandas Dataframe
-            Summary statistics of the Series provided.
-        """
-        return _count_unique_missing(x)
-
-    @classmethod
-    def feature_domain(cls, x: pd.Series) -> schema.Domain:
-        """
-        Generate the domain of the data of this feature type.
-
-        Examples
-        --------
-        >>> s = pd.Series(['2002:db8::', '2001:db8::', '2001:db8::', '2002:db8::', np.NaN, None], name='ip_address_v6')
-        >>> s.ads.feature_type = ['ip_address_v6']
-        >>> s.ads.feature_domain()
-        constraints: []
-        stats:
-            count: 6
-            missing: 2
-            unique: 2
-        values: IpAddressV6
-
-        Returns
-        -------
-        ads.feature_engineering.schema.Domain
-            Domain based on the IpAddressV6 feature type.
-        """
-
-        return schema.Domain(
-            cls.__name__,
-            cls.feature_stat(x).to_dict()[x.name],
-            [],
-        )
-
-
-IpAddressV6.validator.register("is_ip_address_v6", default_handler)

ads/feature_engineering/feature_type/lat_long.py

@@ -1,256 +0,0 @@
-#!/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/
-
-"""
-The module that represents a LatLong feature type.
-
-Classes:
-    LatLong
-        The LatLong feature type.
-
-Functions:
-    default_handler(data: pd.Series) -> pd.Series
-        Processes given data and indicates if the data matches requirements.
-"""
-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,
-    _str_lat_long_to_point,
-    SchemeNeutral,
-    SchemeTeal,
-)
-from ads.feature_engineering import schema
-from ads.common.decorator.runtime_dependency import (
-    runtime_dependency,
-    OptionalDependency,
-)
-
-
-PATTERN = re.compile(r"^[(]?(\-?\d+\.\d+?),\s*(\-?\d+\.\d+?)[)]?$", re.VERBOSE)
-
-
-def default_handler(data: pd.Series, *args, **kwargs) -> pd.Series:
-    """Processes given data and indicates if the data matches requirements.
-
-    Parameters
-    ----------
-    data: :class:`pandas.Series`
-        The data to process.
-
-    Returns
-    -------
-    :class:`pandas.Series`
-        The logical list indicating if the data matches requirements.
-    """
-    return data.apply(
-        lambda x: True
-        if not pd.isnull(x) and PATTERN.match(str(x)) is not None
-        else False
-    )
-
-
-class LatLong(String):
-    """Type representing longitude and latitute.
-
-    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 longitude and latitute.
-
-    Example
-    -------
-    >>> from ads.feature_engineering.feature_type.lat_long import LatLong
-    >>> import pandas as pd
-    >>> s = pd.Series(["-18.2193965, -93.587285",
-                        "-21.0255305, -122.478584",
-                        "85.103913, 19.405744",
-                        "82.913736, 178.225672",
-                        "62.9795085,-66.989705",
-                        "54.5604395,95.235090",
-                        "24.2811855,-162.380403",
-                        "-1.818319,-80.681214",
-                        None,
-                        "(51.816119, 175.979008)",
-                        "(54.3392995,-11.801615)"],
-                        name='latlong')
-    >>> s.ads.feature_type = ['lat_long']
-    >>> LatLong.validator.is_lat_long(s)
-    0      True
-    1      True
-    2      True
-    3      True
-    4      True
-    5      True
-    6      True
-    7      True
-    8     False
-    9      True
-    10     True
-    Name: latlong, dtype: bool
-    """
-
-    description = "Type representing longitude and latitute."
-
-    @staticmethod
-    def feature_stat(x: pd.Series) -> pd.DataFrame:
-        """Generate feature statistics.
-
-        Feature statistics include (total)count, unique(count)
-        and missing(count) if there is any.
-
-        Examples
-        --------
-        >>> latlong_series = pd.Series([
-                    "69.196241,-125.017615",
-                    "5.2272595,-143.465712",
-                    "-33.9855425,-153.445155",
-                    "43.340610,86.460554",
-                    "24.2811855,-162.380403",
-                    "2.7849025,-7.328156",
-                    "45.033805,157.490179",
-                    "-1.818319,-80.681214",
-                    "-44.510428,-169.269477",
-                    "-56.3344375,-166.407038",
-                    "",
-                    np.NaN,
-                    None
-                ],
-            name='latlong'
-        )
-        >>> latlong_series.ads.feature_type = ['lat_long']
-        >>> latlong_series.ads.feature_stat()
-            Metric  Value
-        0	count	13
-        1	unique	10
-        2	missing	3
-
-        Returns
-        -------
-        :class:`pandas.DataFrame`
-            Summary statistics of the Series or Dataframe provided.
-        """
-        return _count_unique_missing(x)
-
-    @staticmethod
-    @runtime_dependency(module="geopandas", install_from=OptionalDependency.GEO)
-    def feature_plot(x: pd.Series) -> plt.Axes:
-        """
-        Shows the location of given address on map base on longitude and latitute.
-
-        Examples
-        --------
-        >>> latlong_series = pd.Series([
-                    "69.196241,-125.017615",
-                    "5.2272595,-143.465712",
-                    "-33.9855425,-153.445155",
-                    "43.340610,86.460554",
-                    "24.2811855,-162.380403",
-                    "2.7849025,-7.328156",
-                    "45.033805,157.490179",
-                    "-1.818319,-80.681214",
-                    "-44.510428,-169.269477",
-                    "-56.3344375,-166.407038",
-                    "",
-                    np.NaN,
-                    None
-                ],
-            name='latlong'
-        )
-        >>> latlong_series.ads.feature_type = ['lat_long']
-        >>> latlong_series.ads.feature_plot()
-
-        Returns
-        -------
-        matplotlib.axes._subplots.AxesSubplot
-            Plot object for the series based on the LatLong feature type.
-        """
-        col_name = x.name if x.name else "latlong"
-        df = x.to_frame(name=col_name)
-        df["validation"] = default_handler(x)
-        df = df[df["validation"] == True]
-        df = (
-            df[col_name]
-            .apply(lambda x: _str_lat_long_to_point(x))
-            .to_frame(name="Coordinates")
-            .dropna()
-        )
-        if len(df.index):
-            df["Coordinates"] = geopandas.GeoSeries.from_wkt(df["Coordinates"])
-            gdf = geopandas.GeoDataFrame(df, geometry="Coordinates")
-            fig, ax = plt.subplots(facecolor=SchemeNeutral.BACKGROUND_LIGHT)
-            world = geopandas.read_file(
-                geopandas.datasets.get_path("naturalearth_lowres")
-            )
-            world.plot(
-                ax=ax, color=SchemeNeutral.AREA_LIGHT, linewidth=0.5, edgecolor="white"
-            )
-            gdf.plot(ax=ax, color=SchemeTeal.LINE_LIGHT, markersize=10)
-            plt.axis("off")
-            return ax
-
-    @classmethod
-    def feature_domain(cls, x: pd.Series) -> schema.Domain:
-        """
-        Generate the domain of the data of this feature type.
-
-        Examples
-        --------
-        >>> latlong_series = pd.Series([
-            "69.196241,-125.017615",
-            "5.2272595,-143.465712",
-            "-33.9855425,-153.445155",
-            "43.340610,86.460554",
-            "24.2811855,-162.380403",
-            "2.7849025,-7.328156",
-            "45.033805,157.490179",
-            "-1.818319,-80.681214",
-            "-44.510428,-169.269477",
-            "-56.3344375,-166.407038",
-            "",
-            np.NaN,
-            None
-            ],
-            name='latlong'
-        )
-        >>> latlong_series.ads.feature_type = ['lat_long']
-        >>> latlong_series.ads.feature_domain()
-        constraints: []
-        stats:
-            count: 13
-            missing: 3
-            unique: 10
-        values: LatLong
-
-        Returns
-        -------
-        ads.feature_engineering.schema.Domain
-            Domain based on the LatLong feature type.
-        """
-
-        return schema.Domain(
-            cls.__name__,
-            cls.feature_stat(x).to_dict()[x.name],
-            [],
-        )
-
-
-LatLong.validator.register("is_lat_long", default_handler)