teradataml 20.0.0.2__py3-none-any.whl → 20.0.0.4__py3-none-any.whl

teradataml/opensource/{sklearn/_wrapper_utils.py → _wrapper_utils.py}

@@ -13,20 +13,19 @@
 # 
 # ##################################################################
 
-import time
 import functools
+import time
 import uuid
-
 from math import floor
+
 from teradataml import TeradataMlException
+from teradataml.common.aed_utils import AedUtils
 from teradataml.common.messagecodes import MessageCodes
 from teradataml.common.messages import Messages
-from teradataml.common.aed_utils import AedUtils
-from teradataml.dataframe.dataframe_utils import DataFrameUtils
-from teradataml.dataframe.dataframe import DataFrame, in_schema
 from teradataml.common.utils import UtilFuncs
+from teradataml.dataframe.dataframe import DataFrame
+from teradataml.dataframe.dataframe_utils import DataFrameUtils
 from teradataml.utils.validators import _Validators
-from teradataml.dataframe.sql_interfaces import ColumnExpression
 
 aed_utils = AedUtils()
 df_utils = DataFrameUtils()

teradataml/options/__init__.py

@@ -7,7 +7,6 @@ from teradataml.utils.internal_buffer import _InternalBuffer
 from teradataml.telemetry_utils.queryband import collect_queryband
 
 
-@argument_deprecation("future", ["auth_token", "ues_url"], False, None)
 @collect_queryband(queryband="StCnfgPrms")
 def set_config_params(**kwargs):
     """
@@ -20,21 +19,6 @@ def set_config_params(**kwargs):
             Optional Argument.
             Specifies keyword arguments. Accepts following keyword arguments:
 
-             auth_token:
-                Optional Parameter.
-                Specifies the authentication token to connect to VantageCloud Lake.
-                Notes:
-                     * Authentication token will expire after a specific time.
-                       One can get the new authentication token and set it again.
-                     * if "auth_token" is set through this function, then this function
-                       should always be used only after create_context.
-                Types: str
-
-            ues_url:
-                Optional Parameter.
-                Specifies the URL for User Environment Service in VantageCloud Lake.
-                Types: str
-
             certificate_file:
                 Optional Parameter.
                 Specifies the path of the certificate file, which is used in
@@ -42,36 +26,42 @@ def set_config_params(**kwargs):
                 Types: str
 
             default_varchar_size:
-                Optional Parameter.
-                Specifies the size of varchar datatype in Vantage, the default
+                Specifies the size of varchar datatype in Teradata Vantage, the default
                 size is 1024.
+                User can configure this parameter using options.
                 Types: int
 
             vantage_version:
-                Specifies the Vantage version teradataml is connected to.
-                Types: str
+                Specifies the Vantage version of the system teradataml is connected to.
+                Types: string
 
             val_install_location:
-                Specifies the database name where Vantage Analytic Library functions
+                Specifies the name of the database where Vantage Analytic Library functions
                 are installed.
-                Types: str
+                Types: string
 
             byom_install_location:
-                Specifies the database name where Bring Your Own Model functions
+                Specifies the name of the database where Bring Your Own Model functions
                 are installed.
-                Types: str
+                Types: string
 
             database_version:
-                Specifies the database version of the system teradataml is connected to.
-                Types: str
+                Specifies the actual database version of the system teradataml is connected to.
+                Types: string
 
             read_nos_function_mapping:
-                Specifies the mapping function name for the read_nos table operator function.
-                Types: str
+                Specifies the function mapping name for the read_nos table operator function.
+                Types: string
 
             write_nos_function_mapping:
-                Specifies the mapping function name for the write_nos table operator function.
-                Types: str
+                Specifies the function mapping name for the write_nos table operator function.
+                Types: string
+
+            inline_plot:
+                Specifies whether to display the plot inline or not.
+                Note:
+                    Not applicable for machines running Linux and Mac OS.
+                Types: bool
 
             indb_install_location:
                 Specifies the installation location of In-DB Python package.
@@ -82,9 +72,35 @@ def set_config_params(**kwargs):
                     Older versions of In-DB packages are installed at
                     "/opt/teradata/languages/Python/".
 
+            openml_user_env:
+                Specifies the user environment to be used for OpenML.
+                Types: UserEnv
+
             local_storage:
                 Specifies the location on client where garbage collector folder will be created.
-                Types: str
+                Types: string
+
+            stored_procedure_install_location:
+                Specifies the name of the database where stored procedures
+                are installed.
+                Types: string
+
+            table_operator:
+                Specifies the name of the table operator.
+                Permitted Values: "Apply", "Script"
+                Types: string
+
+            temp_object_type:
+                Specifies the type of temporary database objects created internally by teradataml.
+                Permitted Values:
+                    * "VT" - Volatile tables.
+                Types: String
+                Default Value: None
+                Note:
+                    * If this option is set to "VT" and "persist" argument of analytic functions is
+                      set to True, then volatile tables are not created as volatile table can't be
+                      persisted and "persist" argument takes precedence.
+                    * Default behavior is to create views that will be garbage collected at the end.
 
     RETURNS:
         bool
@@ -95,9 +111,7 @@ def set_config_params(**kwargs):
     EXAMPLES:
         # Example 1: Set configuration params using set_config_params() function.
         >>> from teradataml import set_config_params
-        >>> set_config_params(auth_token="abc-pqr-123",
-        ...                   ues_url="https://teracloud/v1/accounts/xyz-234-76085/open-analytics",
-        ...                   certificate_file="cert.crt",
+        >>> set_config_params(certificate_file="cert.crt",
         ...                   default_varchar_size=512,
         ...                   val_install_location="VAL_USER",
         ...                   read_nos_function_mapping="read_nos_fm",
@@ -109,7 +123,6 @@ def set_config_params(**kwargs):
         # Example 2: Alternatively, set configuration parameters without using set_config_params() function.
         #            To do so, we will use configure module.
         >>> from teradataml import configure
-        >>> configure.ues_url="https://teracloud/v1/accounts/xyz-234-76085/open-analytics"
         >>> configure.certificate_file="cert.crt"
         >>> configure.default_varchar_size=512
         >>> configure.val_install_location="VAL_USER"
@@ -120,9 +133,12 @@ def set_config_params(**kwargs):
     """
     for option in kwargs:
         try:
-            if option == "auth_token":
-                from teradataml.scriptmgmt.lls_utils import _AuthToken
-                _InternalBuffer.add(auth_token=_AuthToken(token=kwargs[option]))
+            if option == "auth_token" or option == 'ues_url':
+                raise TeradataMlException(Messages.get_message(
+                    MessageCodes.FUNC_EXECUTION_FAILED, 'set_config_params',
+                    'Setting of parameter \'{}\' is prohibited from set_config_params(). '
+                    'Use set_auth_token() to set parameter.'.format(option)),
+                    MessageCodes.FUNC_EXECUTION_FAILED)
             else:
                 setattr(configure, option, kwargs[option])
         except AttributeError as e:

teradataml/options/configure.py

@@ -13,6 +13,7 @@ from teradataml.common.exceptions import TeradataMlException
 from teradataml.common.messages import Messages
 from teradataml.common.messagecodes import MessageCodes
 
+
 class _ConfigureSuper(object):
 
     def __init__(self):
@@ -59,15 +60,18 @@ class _Configure(_ConfigureSuper):
     openml_user_env = _create_property('openml_user_env')
     local_storage = _create_property('local_storage')
     stored_procedure_install_location = _create_property('stored_procedure_install_location')
+    table_operator = _create_property('table_operator')
+    temp_object_type = _create_property('temp_object_type')
 
-    def __init__(self, default_varchar_size=1024, column_casesensitive_handler = False,
+    def __init__(self, default_varchar_size=1024, column_casesensitive_handler=False,
                  vantage_version="vantage1.1", val_install_location=None,
                  byom_install_location=None, temp_table_database=None,
                  temp_view_database=None, database_version=None,
                  read_nos_function_mapping="read_nos", write_nos_function_mapping="write_nos",
-                 cran_repositories=None, inline_plot=True, 
-                 indb_install_location="/var/opt/teradata/languages/sles12sp3/Python/",
-                 openml_user_env=None, local_storage=None, stored_procedure_install_location="SYSLIB"):
+                 cran_repositories=None, inline_plot=True,
+                 indb_install_location=None,
+                 openml_user_env=None, local_storage=None, stored_procedure_install_location="SYSLIB",
+                 table_operator=None, temp_object_type=None):
 
         """
         PARAMETERS:
@@ -79,17 +83,6 @@ class _Configure(_ConfigureSuper):
                 Example:
                     teradataml.options.configure.default_varchar_size = 512
 
-            column_casesensitive_handler:
-                Specifies a boolean value that sets the value of this option to True or
-                False.
-                One should set this to True, when ML Engine connector property is
-                CASE-SENSITIVE, else set to False, which is CASE-INSENSITIVE.
-                Types: bool
-                Example:
-                    # When ML Engine connector property is CASE-SENSITIVE, set this
-                    # parameter to True.
-                    teradataml.options.configure.column_casesensitive_handler = True
-
             vantage_version:
                 Specifies the Vantage version of the system teradataml is connected to.
                 Types: string
@@ -139,7 +132,7 @@ class _Configure(_ConfigureSuper):
             inline_plot:
                 Specifies whether to display the plot inline or not.
                 Note:
-                    Not applicable for machines running linux and mac os.
+                    Not applicable for machines running Linux and Mac OS.
                 Types: bool
                 Example:
                     # Set the option to display plot in a separate window.
@@ -149,10 +142,6 @@ class _Configure(_ConfigureSuper):
                 Specifies the installation location of In-DB Python package.
                 Types: string
                 Default Value: "/var/opt/teradata/languages/sles12sp3/Python/"
-                Note:
-                    The default value is the installation location of In-DB 2.0.0 packages.
-                    Older versions of In-DB packages are installed at
-                    "/opt/teradata/languages/Python/".
                 Example:
                     # Set the installation location for older versions.
                     teradataml.options.configure.indb_install_location = "/opt/teradata/languages/Python/"
@@ -181,6 +170,29 @@ class _Configure(_ConfigureSuper):
                     # when stored procedures are installed in 'SYSLIB'.
                     teradataml.options.configure.stored_procedure_install_location = "SYSLIB"
 
+            table_operator:
+                Specifies the name of the table operator.
+                Permitted Values: "Apply", "Script"
+                Types: string
+                Example:
+                    # Set the table operator name to "Script"
+                    teradataml.options.configure.table_operator = "Script"
+
+            temp_object_type:
+                Specifies the type of temporary database objects created internally by teradataml.
+                Permitted Values:
+                    * "VT" - Volatile tables.
+                Types: String
+                Default Value: None
+                Note:
+                    * If this option is set to "VT" and "persist" argument of analytic functions is
+                      set to True, then volatile tables are not created as volatile table can't be
+                      persisted and "persist" argument takes precedence.
+                    * Default behavior is to create views that will be garbage collected at the end.
+                Example:
+                    # Set the type of temporary database objects to "VT" to create volatile internal
+                    # tables.
+                    teradataml.options.configure.temp_object_type = "VT"
         """
         super().__init__()
         super().__setattr__('default_varchar_size', default_varchar_size)
@@ -195,10 +207,12 @@ class _Configure(_ConfigureSuper):
         super().__setattr__('write_nos_function_mapping', write_nos_function_mapping)
         super().__setattr__('cran_repositories', cran_repositories)
         super().__setattr__('inline_plot', True)
-        super().__setattr__('indb_install_location', indb_install_location)
         super().__setattr__('openml_user_env', openml_user_env)
         super().__setattr__('local_storage', local_storage)
         super().__setattr__('stored_procedure_install_location', stored_procedure_install_location)
+        super().__setattr__('table_operator', table_operator)
+        super().__setattr__('_indb_install_location', indb_install_location)
+        super().__setattr__('temp_object_type', self.__get_temp_object_type(temp_object_type))
 
         # internal configurations
         # These configurations are internal and should not be
@@ -228,6 +242,11 @@ class _Configure(_ConfigureSuper):
         # Internal parameter, that is used for specifying the URL to be used as
         # base URL in UES REST calls
         super().__setattr__('ues_url', None)
+        # base URL in Vector Store REST calls
+        super().__setattr__('_vector_store_base_url', None)
+        # Whether tenant is CCP enabled or not.
+        # By default, it is set to False, as it can be Enterprise or NON-CCP.
+        super().__setattr__('_ccp_enabled', False)
         # Internal parameter, that is used to specify the certificate file in a secured HTTP request.
         super().__setattr__('certificate_file', False)
         # Internal parameter, that is used for specify the maximum size of the file
@@ -248,6 +267,46 @@ class _Configure(_ConfigureSuper):
         # Internal parameter, that is used for specifying the database username associated with current connection.
         super().__setattr__('_database_username', None)
 
+    @property
+    def indb_install_location(self):
+        """
+        DESCRIPTION:
+            Specifies the installation location of In-DB Python package.
+
+        RAISES:
+            Operational Error.
+        """
+        if self._indb_install_location:
+            return self._indb_install_location
+        from teradataml.context.context import get_context
+        if get_context():
+            from teradataml.common.constants import TableOperatorConstants
+            from teradataml.utils.utils import execute_sql
+            _path = execute_sql(TableOperatorConstants.INDB_PYTHON_PATH.value).fetchall()[0][0]
+            if 'sles:12:sp3' in _path:
+                self._indb_install_location = '/var/opt/teradata/languages/sles12sp3/Python/'
+            elif 'sles:15:sp4' in _path:
+                self._indb_install_location = '/var/opt/teradata/languages/sles15sp4/Python/'
+            else:
+                self._indb_install_location = '/opt/teradata/languages/Python/'
+            return self._indb_install_location
+        else:
+            return '/var/opt/teradata/languages/sles12sp3/Python/'
+
+    @indb_install_location.setter
+    def indb_install_location(self, value):
+        """
+        DESCRIPTION:
+            Sets the value to "indb_install_location" by user.
+
+        PARAMETERS:
+            value:
+                Required Argument.
+                Specifies the value assigned to "indb_install_location".
+                Types: str
+        """
+        self._indb_install_location = value
+
     def __setattr__(self, name, value):
         if hasattr(self, name):
             if name == 'default_varchar_size':
@@ -260,7 +319,9 @@ class _Configure(_ConfigureSuper):
                                                                    "greater than"),
                                               MessageCodes.TDMLDF_POSITIVE_INT)
             elif name == '_ues_max_file_upload_size':
-                if type(value) != int:
+                # If the value is bool, isinstance(value, int) returns True
+                # which is wrong, hence added the condition on bool.
+                if isinstance(value, bool) or not isinstance(value, int):
                     raise TeradataMlException(Messages.get_message(MessageCodes.UNSUPPORTED_DATATYPE, name,
                                                                    'int'),
                                               MessageCodes.UNSUPPORTED_DATATYPE)
@@ -269,7 +330,7 @@ class _Configure(_ConfigureSuper):
                                                                    "greater than or equal to"),
                                               MessageCodes.TDMLDF_POSITIVE_INT)
             elif name in ['column_casesensitive_handler', '_validate_metaexpression',
-                          '_validate_gc', 'inline_plot', '_oauth']:
+                          '_validate_gc', 'inline_plot', '_oauth', '_ccp_enabled']:
 
                 if not isinstance(value, bool):
                     raise TeradataMlException(Messages.get_message(MessageCodes.UNSUPPORTED_DATATYPE, name,
@@ -325,7 +386,7 @@ class _Configure(_ConfigureSuper):
                             Messages.get_message(MessageCodes.PATH_NOT_FOUND).format(value),
                             MessageCodes.PATH_NOT_FOUND)
 
-            elif name in {'ues_url', '_oauth_end_point', '_oauth_client_id'}:
+            elif name in {'ues_url', '_oauth_end_point', '_oauth_client_id', '_vector_store_base_url'}:
 
                 if not isinstance(value, str):
                     raise TypeError(Messages.get_message(MessageCodes.UNSUPPORTED_DATATYPE, name, 'str'))
@@ -333,7 +394,7 @@ class _Configure(_ConfigureSuper):
                 if len(value) == 0:
                     raise ValueError(Messages.get_message(MessageCodes.ARG_EMPTY, name))
 
-                if name == 'ues_url':
+                if name in ['ues_url', '_vector_store_base_url']:
                     value = value[: -1] if value.endswith("/") else value
 
             elif name in ['temp_table_database', 'temp_view_database',
@@ -355,16 +416,59 @@ class _Configure(_ConfigureSuper):
                     for url in value:
                         if not isinstance(url, str):
                             raise TypeError(
-                                Messages.get_message(MessageCodes.UNSUPPORTED_DATATYPE, name, 'str, list of str or None'))
+                                Messages.get_message(MessageCodes.UNSUPPORTED_DATATYPE, name,
+                                                     'str, list of str or None'))
 
             elif name == 'openml_user_env':
                 from teradataml.scriptmgmt.UserEnv import UserEnv
                 if not isinstance(value, UserEnv) and not isinstance(value, type(None)):
                     raise TypeError(Messages.get_message(MessageCodes.UNSUPPORTED_DATATYPE, name, 'UserEnv or None'))
 
+            elif name == 'table_operator':
+                if not isinstance(value, str) and not isinstance(value, type(None)):
+                    raise TypeError(Messages.get_message(MessageCodes.UNSUPPORTED_DATATYPE, name, 'str or None'))
+
+                if value is not None:
+                    valid_names = ['script', 'apply']
+                    value = value.lower()
+                    if value not in valid_names:
+                        raise TeradataMlException(Messages.get_message(MessageCodes.INVALID_ARG_VALUE,
+                                                                       value,
+                                                                       name,
+                                                                       "a value in {}".format(valid_names)),
+                                                  MessageCodes.INVALID_ARG_VALUE)
+            elif name == "temp_object_type":
+                self.__validate_db_tbl_attrs(name, value)
+                valid_object_typs = ['VT']
+                if value and value.upper() not in valid_object_typs:
+                    raise ValueError(Messages.get_message(MessageCodes.INVALID_ARG_VALUE,
+                                                          value,
+                                                          name,
+                                                          "a value in {}".format(valid_object_typs)))
+
+                value = self.__get_temp_object_type(value)
+
             super().__setattr__(name, value)
         else:
             raise AttributeError("'{}' object has no attribute '{}'".format(self.__class__.__name__, name))
 
+    def __get_temp_object_type(self, value):
+        """
+        Get the temporary object type based on the value provided.
+        Default behavior is to create views that will be garbage collected at the end.
+        """
+        from teradataml.common.constants import TeradataConstants
+        if value and value.upper() == "VT":
+            return TeradataConstants.TERADATA_VOLATILE_TABLE
+        # This we will need in the future.
+        # elif value and value.upper() in ["TT", "PT"]:
+        #     return TeradataConstants.TERADATA_TABLE
+        return TeradataConstants.TERADATA_VIEW
+
+    def __validate_db_tbl_attrs(self, name, value):
+        if not isinstance(value, str) and not isinstance(value, type(None)):
+            raise TypeError(Messages.get_message(MessageCodes.UNSUPPORTED_DATATYPE, name,
+                                                 'str or None'))
+
 
-configure = _Configure()
+configure = _Configure()

teradataml/options/display.py

@@ -51,6 +51,7 @@ class _Display(_DisplaySuper):
     blob_length = _create_property('blob_length')
     suppress_vantage_runtime_warnings = _create_property('suppress_vantage_runtime_warnings')
     geometry_column_length = _create_property('geometry_column_length')
+    enable_ui = _create_property('enable_ui')
 
     def __init__(self,
                  max_rows = 10,
@@ -59,7 +60,8 @@ class _Display(_DisplaySuper):
                  print_sqlmr_query = False,
                  blob_length=10,
                  suppress_vantage_runtime_warnings=True,
-                 geometry_column_length=30):
+                 geometry_column_length=30,
+                 enable_ui=True):
         """
         PARAMETERS:
             max_rows:
@@ -115,6 +117,14 @@ class _Display(_DisplaySuper):
                 Types: bool
                 Example:
                     display.suppress_vantage_runtime_warnings = True
+
+            enable_ui:
+                Specifies whether to display exploratory data analysis UI when DataFrame is printed or not.
+                When set to True, UI is enabled to be displayed, otherwise it is disabled.
+                Default Value: True
+                Types: bool
+                Example:
+                    display.enable_ui = True
         """
         super().__init__()
         super().__setattr__('max_rows', max_rows)
@@ -124,6 +134,7 @@ class _Display(_DisplaySuper):
         super().__setattr__('blob_length', blob_length)
         super().__setattr__('suppress_vantage_runtime_warnings', suppress_vantage_runtime_warnings)
         super().__setattr__('geometry_column_length', geometry_column_length)
+        super().__setattr__('enable_ui', enable_ui)
 
     def __setattr__(self, name, value):
         if hasattr(self, name):
@@ -149,7 +160,7 @@ class _Display(_DisplaySuper):
                                                                    name,
                                                                    "a value in {}".format(valid_encodings)),
                                               MessageCodes.INVALID_ARG_VALUE)
-            elif name == 'print_sqlmr_query':
+            elif name == 'print_sqlmr_query' or name == 'enable_ui':
                 if not isinstance(value, bool):
                     raise TeradataMlException(Messages.get_message(MessageCodes.UNSUPPORTED_DATATYPE, name,
                                                                    'bool'),

teradataml/plot/axis.py

@@ -20,6 +20,7 @@ from teradataml.dataframe.sql import ColumnExpression
 from teradataml.plot.constants import MapType
 from teradataml.utils.validators import _Validators
 
+
 class Axis:
     def __init__(self, **kwargs):
         """
@@ -421,9 +422,47 @@ class Axis:
         self.__series_options = kwargs.get("series_options")  # Specifies SQL element - ID_SEQUENCE
 
         # Get the series identifier. If it is a column expression, get the column name from it.
-        self.__series_identifier = kwargs.get("series_identifier")
-        if not isinstance(self.__series_identifier, str) and self.__series_identifier is not None:
-            self.__series_identifier = self.__series_identifier.name
+        self.series_identifier = kwargs.get("series_identifier")
+        if not isinstance(self.series_identifier, str) and self.series_identifier is not None:
+            self.series_identifier = self.series_identifier.name
+
+    def __eq__(self, other):
+        """
+        DESCRIPTION:
+            Magic method to check if two Axis objects are equal or not.
+            If all the associated parameters are same, then two Axis objects
+            are equal. Else, they are not equal.
+
+        PARAMETERS:
+            other:
+                Required Argument.
+                Specifies the object of Axis.
+                Types: Axis
+
+        RETURNS:
+            bool
+
+        RAISES:
+            None.
+
+        EXAMPLES:
+            >>> Axis() == Axis()
+        """
+        attrs = ["cmap", "color", "grid_color",
+                 "grid_format", "grid_linestyle", "grid_linewidth",
+                 "legend", "legend_style", "linestyle",
+                 "linewidth", "marker", "markersize", "position",
+                 "span", "reverse_xaxis", "reverse_yaxis", "series_identifier",
+                 "title", "xlabel", "xlim", "xtick_format", "ylabel", "ylim", "ytick_format",
+                 "vmin", "vmax", "ignore_nulls", "kind"]
+
+        for attr in attrs:
+            if getattr(self, attr) == getattr(other, attr):
+                continue
+            else:
+                return False
+
+        return True
 
     def __get_param(self, param):
         """
@@ -940,7 +979,7 @@ class Axis:
         """
         from teradataml.dataframe.dataframe import TDSeries
 
-        if self.__series_identifier:
+        if self.series_identifier:
             # Remove null values from DataFrame
             if self.ignore_nulls:
                 _df = self.__x_axis_data[0]._parent_df
@@ -954,7 +993,7 @@ class Axis:
                 self.__y_axis_data[0]._parent_df.materialize()
 
             series = TDSeries(data=_df if self.ignore_nulls else self.__x_axis_data[0]._parent_df,
-                              id=self.__series_identifier,
+                              id=self.series_identifier,
                               row_index=self.__x_axis_data[0].name,
                               row_index_style=self.__get_index_style(self.__x_axis_data[0]),
                               payload_field=self.__y_axis_data[0].name,
@@ -1038,7 +1077,7 @@ class Axis:
         """
         from teradataml.dataframe.dataframe import TDMatrix
 
-        if self.__series_identifier:
+        if self.series_identifier:
             # Remove null values from DataFrame
             if self.ignore_nulls:
                 _df = self.__x_axis_data[0]._parent_df
@@ -1052,7 +1091,7 @@ class Axis:
                 self.__y_axis_data[0]._parent_df.materialize()
 
             matrix = TDMatrix(data=_df if self.ignore_nulls else self.__x_axis_data[0]._parent_df,
-                              id=self.__series_identifier,
+                              id=self.series_identifier,
                               row_index=self.__x_axis_data[0].name,
                               row_index_style=self.__get_index_style(self.__x_axis_data[0]),
                               column_index=self.__y_axis_data[0].name,
@@ -1242,7 +1281,7 @@ class Axis:
 
         # For subplot or multiple series, make sure to populate legend.
         # For mainplot, leave it to user's choice.
-        if self._is_sub_plot() or self.__series_identifier or (len(self.__y_axis_data) > 1) and \
+        if self._is_sub_plot() or self.series_identifier or (len(self.__y_axis_data) > 1) and \
                 self.kind not in (MapType.MESH.value, MapType.WIGGLE.value):
             func_params["LEGEND"] = "'{}'".format("best" if not self.legend_style else self.legend_style)
         else:

teradataml/plot/figure.py

@@ -111,6 +111,39 @@ class Figure:
 
         self._plot_axis = {}
 
+    def __eq__(self, other):
+        """
+        DESCRIPTION:
+            Magic method to check if two Figure objects are equal or not.
+            If all the associated parameters are same, then two Figure objects
+            are equal. Else, they are not equal.
+
+        PARAMETERS:
+            other:
+                Required Argument.
+                Specifies the object of Figure.
+                Types: Figure
+
+        RETURNS:
+            bool
+
+        RAISES:
+            None.
+
+        EXAMPLES:
+            >>> Figure() == Figure()
+        """
+        attrs = ["width", "height", "image_type", "dpi", "heading",
+                 "layout"]
+
+        for attr in attrs:
+            if getattr(self, attr) == getattr(other, attr):
+                continue
+            else:
+                return False
+
+        return True
+
     @property
     def height(self):
         """