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

teradataml/README.md

@@ -16,6 +16,189 @@ Copyright 2024, Teradata. All Rights Reserved.
 * [License](#license)
 
 ## Release Notes:
+#### teradataml 20.00.00.02
+
+* teradataml will no longer be supported with SQLAlchemy < 2.0.
+* teradataml no longer shows the warnings from Vantage by default. 
+  * Users should set `display.suppress_vantage_runtime_warnings` to `False` to display warnings.
+
+* ##### New Features/Functionality
+  * ##### teradataml: SQLE Engine Analytic Functions
+    * New Analytics Database Analytic Functions:
+      * `TFIDF()`
+      * `Pivoting()`
+      * `UnPivoting()`
+    * New Unbounded Array Framework(UAF) Functions:
+      * `AutoArima()`
+      * `DWT()`
+      * `DWT2D()`
+      * `FilterFactory1d()`  
+      * `IDWT()`
+      * `IDWT2D()`
+      * `IQR()`
+      * `Matrix2Image()`
+      * `SAX()`
+      * `WindowDFFT()`
+  * ###### teradataml: Functions
+      * `udf()` - Creates a user defined function (UDF) and returns ColumnExpression.
+      * `set_session_param()` is added to set the database session parameters. 
+      * `unset_session_param()` is added to unset database session parameters.
+  
+  * ###### teradataml: DataFrame
+      * `materialize()` - Persists DataFrame into database for current session.
+      * `create_temp_view()` - Creates a temporary view for session on the DataFrame.
+
+  * ###### teradataml DataFrameColumn a.k.a. ColumnExpression
+      * _Date Time Functions_
+        * `DataFrameColumn.to_timestamp()` - Converts string or integer value to a TIMESTAMP data type or TIMESTAMP WITH TIME ZONE data type.
+        * `DataFrameColumn.extract()` - Extracts date component to a numeric value.
+        * `DataFrameColumn.to_interval()` - Converts a numeric value or string value into an INTERVAL_DAY_TO_SECOND or INTERVAL_YEAR_TO_MONTH value.
+      * _String Functions_
+        * `DataFrameColumn.parse_url()` - Extracts a part from a URL.
+      * _Arithmetic Functions_
+        * `DataFrameColumn.log` - Returns the logarithm value of the column with respect to 'base'.
+
+  * ##### teradataml: AutoML
+      * New methods added for `AutoML()`, `AutoRegressor()` and `AutoClassifier()`:
+        * `evaluate()` - Performs evaluation on the data using the best model or the model of users choice
+          from the leaderboard.
+        * `load()`: Loads the saved model from database.
+        * `deploy()`: Saves the trained model inside database.
+        * `remove_saved_model()`: Removes the saved model in database.
+        * `model_hyperparameters()`: Returns the hyperparameter of fitted or loaded models.
+
+* ##### Updates
+  * ##### teradataml: AutoML
+    * `AutoML()`, `AutoRegressor()`
+      * New performance metrics added for task type regression i.e., "MAPE", "MPE", "ME", "EV", "MPD" and "MGD".
+    * `AutoML()`, `AutoRegressor()` and `AutoClassifier`
+      * New arguments added: `volatile`, `persist`.
+      * `predict()` - Data input is now mandatory for generating predictions. Default model 
+      evaluation is now removed.
+  * `DataFrameColumn.cast()`: Accepts 2 new arguments `format` and `timezone`.
+  * `DataFrame.assign()`: Accepts ColumnExpressions returned by `udf()`.
+
+  * ##### teradataml: Options
+    * `set_config_params()`
+      * Following arguments will be deprecated in the future:
+        * `ues_url`
+        * `auth_token`
+
+  * ###### Database Utility
+      * `list_td_reserved_keywords()` - Accepts a list of strings as argument.
+
+  * ##### Updates to existing UAF Functions:
+    * `ACF()` - `round_results` parameter removed as it was used for internal testing.
+    * `BreuschGodfrey()` - Added default_value 0.05 for parameter `significance_level`.
+    * `GoldfeldQuandt()` - 
+      * Removed parameters  `weights` and `formula`.
+        Replaced parameter `orig_regr_paramcnt` with `const_term`.
+        Changed description for parameter `algorithm`. Please refer document for more details.
+      * Note: This will break backward compatibility.
+    * `HoltWintersForecaster()` - Default value of parameter `seasonal_periods` removed.
+    * `IDFFT2()` - Removed parameter `output_fmt_row_major` as it is used for internal testing.
+    * `Resample()` - Added parameter `output_fmt_index_style`.
+
+* ##### Bug Fixes
+  * KNN `predict()` function can now predict on test data which does not contain target column.
+  * Metrics functions are supported on the Lake system.
+  * The following OpensourceML functions from different sklearn modules are fixed.
+    * `sklearn.ensemble`:
+      * ExtraTreesClassifier - `apply()`
+      * ExtraTreesRegressor - `apply()`
+      * RandomForestClassifier - `apply()`
+      * RandomForestRegressor - `apply()`
+    * `sklearn.impute`:
+      * SimpleImputer - `transform()`, `fit_transform()`, `inverse_transform()`
+      * MissingIndicator - `transform()`, `fit_transform()`
+    * `sklearn.kernel_approximations`:
+      * Nystroem - `transform()`, `fit_transform()`
+      * PolynomialCountSketch - `transform()`, `fit_transform()`
+      * RBFSampler - `transform()`, `fit_transform()`
+    * `sklearn.neighbours`:
+      * KNeighborsTransformer - `transform()`, `fit_transform()`
+      * RadiusNeighborsTransformer - `transform()`, `fit_transform()`
+    * `sklearn.preprocessing`:
+      * KernelCenterer - `transform()`
+      * OneHotEncoder - `transform()`, `inverse_transform()`
+  * OpensourceML returns teradataml objects for model attributes and functions instead of sklearn
+    objects so that the user can perform further operations like `score()`, `predict()` etc on top
+    of the returned objects.
+  * AutoML `predict()` function now generates correct ROC-AUC value for positive class.
+  * `deploy()` method of `Script` and `Apply` classes retries model deployment if there is any 
+    intermittent network issues.
+
+#### teradataml 20.00.00.01
+* teradataml no longer supports Python versions less than 3.8.
+
+* ##### New Features/Functionality
+  * ##### Personal Access Token (PAT) support in teradataml
+    * `set_auth_token()` - teradataml now supports authentication via PAT in addition to 
+      OAuth 2.0 Device Authorization Grant (formerly known as the Device Flow).
+      * It accepts UES URL, Personal AccessToken (PAT) and Private Key file generated from VantageCloud Lake Console 
+        and optional argument `username` and `expiration_time` in seconds. 
+
+* ##### Updates
+  * ##### teradataml: SQLE Engine Analytic Functions
+    * `ANOVA()`
+      * New arguments added: `group_name_column`, `group_value_name`, `group_names`, `num_groups` for data containing group values and group names. 
+    * `FTest()`
+      * New arguments added: `sample_name_column`, `sample_name_value`, `first_sample_name`, `second_sample_name`.
+    * `GLM()`
+      * Supports stepwise regression and accept new arguments `stepwise_direction`, `max_steps_num` and `initial_stepwise_columns`.
+      * New arguments added: `attribute_data`, `parameter_data`, `iteration_mode` and `partition_column`.
+    * `GetFutileColumns()`
+      * Arguments `category_summary_column` and `threshold_value` are now optional.
+    * `KMeans()`
+      * New argument added: `initialcentroids_method`.
+    * `NonLinearCombineFit()`
+        * Argument `result_column` is now optional.
+    * `ROC()`
+        * Argument `positive_class` is now optional. 
+    * `SVMPredict()`
+      * New argument added: `model_type`.   
+    * `ScaleFit()`
+      * New arguments added: `ignoreinvalid_locationscale`, `unused_attributes`, `attribute_name_column`, `attribute_value_column`.
+      * Arguments `attribute_name_column`, `attribute_value_column` and `target_attributes` are supported for sparse input.
+      * Arguments `attribute_data`, `parameter_data` and `partition_column` are supported for partitioning.
+    * `ScaleTransform()`
+      * New arguments added: `attribute_name_column` and `attribute_value_column` support for sparse input.
+    * `TDGLMPredict()`
+      * New arguments added: `family` and `partition_column`.
+    * `XGBoost()`
+      * New argument `base_score` is added for initial prediction value for all data points.
+    * `XGBoostPredict()`
+      * New argument `detailed` is added for detailed information of each prediction.
+    * `ZTest()`
+      * New arguments added: `sample_name_column`, `sample_value_column`,  `first_sample_name` and `second_sample_name`.
+  * ##### teradataml: AutoML
+    * `AutoML()`, `AutoRegressor()` and `AutoClassifier()`
+      * New argument `max_models` is added as an early stopping criterion to limit the maximum number of models to be trained.
+  * ##### teradataml: DataFrame functions
+    * `DataFrame.agg()` 
+      * Accepts ColumnExpressions and list of ColumnExpressions as arguments.
+  * ##### teradataml: General Functions
+    * Data Transfer Utility
+      * `fastload()` - Improved error and warning table handling with below-mentioned new arguments.
+        * `err_staging_db`
+        * `err_tbl_name`
+        * `warn_tbl_name`
+        * `err_tbl_1_suffix`
+        * `err_tbl_2_suffix`
+      * `fastload()` - Change in behaviour of `save_errors` argument.
+                       When `save_errors` is set to `True`, error information will be available in two persistent tables `ERR_1` and `ERR_2`.
+                       When `save_errors` is set to `False`, error information will be available in single pandas dataframe.
+    * Garbage collector location is now configurable. 
+      User can set configure.local_storage to a desired location.
+      
+* ##### Bug Fixes
+  * UAF functions now work if the database name has special characters.
+  * OpensourceML can now read and process NULL/nan values.
+  * Boolean values output will now be returned as VARBYTE column with 0 or 1 values in OpensourceML.
+  * Fixed bug for `Apply`'s `deploy()`.
+  * Issue with volatile table creation is fixed where it is created in the right database, i.e., user's spool space, regardless of the temp database specified.
+  * `ColumnTransformer` function now processes its arguments in the order they are passed.
+
 #### teradataml 20.00.00.00
 * ##### New Features/Functionality
     * ###### teradataml OpenML: Run Opensource packages through Teradata Vantage

teradataml/__init__.py

@@ -64,7 +64,10 @@ from teradataml.opensource import *
 # Import AutoML
 from teradataml.automl import AutoML, AutoRegressor, AutoClassifier
 
-
-# Configure app name and app version for querybands
-from teradatasqlalchemy.telemetry.queryband import session_queryband
+# Import global variable representing session_queryband.
+from teradataml.telemetry_utils.queryband import session_queryband
+# Configure app name and app version for teradataml querybands.
 session_queryband.configure_queryband_parameters(app_name="TDML", app_version=__version__)
+
+# Import functions.
+from teradataml.dataframe.functions import *

teradataml/_version.py

@@ -1,6 +1,6 @@
 # ##################################################################
 # 
-# Copyright 2021 Teradata. All rights reserved.
+# Copyright 2024 Teradata. All rights reserved.
 # TERADATA CONFIDENTIAL AND TRADE SECRET
 # 
 # Primary Owner: Pankaj Purandare (PankajVinod.Purandare@teradata.com)
@@ -8,4 +8,4 @@
 # 
 # ################################################################## 
 
-version = "20.00.00.00"
+version = "20.00.00.02"

teradataml/analytics/__init__.py

@@ -22,7 +22,7 @@ from .Transformations import Binning, Derive, OneHotEncoder, FillNa, LabelEncode
     Retain, Sigmoid, ZScore
 from teradataml.analytics.json_parser.utils import _get_json_data_from_tdml_repo, _process_paired_functions
 from teradataml.analytics.analytic_function_executor import _SQLEFunctionExecutor, _TableOperatorExecutor,\
-    _UAFFunctionExecutor, _BYOMFunctionExecutor
+    _UAFFunctionExecutor, _BYOMFunctionExecutor, _StoredProcedureExecutor
 from teradataml.common.constants import TeradataAnalyticFunctionTypes
 
 
@@ -76,6 +76,7 @@ def _get_executor_class_name(function_type):
         TeradataAnalyticFunctionTypes.SQLE.value: _SQLEFunctionExecutor,
         TeradataAnalyticFunctionTypes.TABLEOPERATOR.value: _TableOperatorExecutor,
         TeradataAnalyticFunctionTypes.UAF.value: _UAFFunctionExecutor,
-        TeradataAnalyticFunctionTypes.BYOM.value: _BYOMFunctionExecutor
+        TeradataAnalyticFunctionTypes.BYOM.value: _BYOMFunctionExecutor,
+        TeradataAnalyticFunctionTypes.STORED_PROCEDURE.value: _StoredProcedureExecutor
     }
     return func_type_to_executor.get(function_type.upper(), _SQLEFunctionExecutor).__name__