Teradata Package for Python Function Reference on VantageCloud Lake - atanh - Teradata Package for Python - Look here for syntax, methods and examples for the functions included in the Teradata Package for Python.
Teradata® Package for Python Function Reference on VantageCloud Lake
- Deployment
- VantageCloud
- Edition
- Lake
- Product
- Teradata Package for Python
- Release Number
- 20.00.00.03
- Published
- December 2024
- ft:locale
- en-US
- ft:lastEdition
- 2024-12-19
- dita:id
- TeradataPython_FxRef_Lake_2000
- Product Category
- Teradata Vantage
- teradataml.dataframe.sql.DataFrameColumn.atanh = atanh()
- DESCRIPTION:
Function computes the inverse hyperbolic tangent value of the values in column.
NOTES:
1. If the type of the column is not FLOAT, column values are converted to FLOAT
based on implicit type conversion rules. If the value cannot be converted, an
error is reported.
2. Unsupported column types:
a. BYTE or VARBYTE
b. LOBs (BLOB or CLOB)
c. CHARACTER or VARCHAR if the server character set is GRAPHIC
RAISES:
TypeError, ValueError, TeradataMlException
RETURNS:
DataFrameColumn
EXAMPLES:
# Load the data to execute the example.
>>> load_example_data("dataframe", "admissions_train")
# Create a DataFrame on 'admissions_train' table.
>>> df = DataFrame("admissions_train").iloc[:4]
>>> print(df)
masters gpa stats programming admitted
id
3 no 3.70 Novice Beginner 1
4 yes 3.50 Beginner Novice 1
2 yes 3.76 Beginner Beginner 0
1 yes 3.95 Beginner Beginner 0
# Example 1: Calculate inverse hyperbolic tan value for the 'gpa column values/10'
# and pass it as input to DataFrame.assign().
>>> result = df.assign(col = (df.gpa / 10).atanh())
>>> print(result)
masters gpa stats programming admitted col
id
3 no 3.70 Novice Beginner 1 0.388423
4 yes 3.50 Beginner Novice 1 0.365444
2 yes 3.76 Beginner Beginner 0 0.395393
1 yes 3.95 Beginner Beginner 0 0.417711
# Example 2: Filter the rows where inverse hyperbolic tangent of values in 'gpa column values/10'
# column are greater than 0.4.
>>> print(df[(df.gpa/10).atanh() > 0.4])
masters gpa stats programming admitted
id
1 yes 3.95 Beginner Beginner 0