arc_hyperbolic_expansion
Bases: transformation
The arc hyperbolic data expansion function.
It performs the arc hyperbolic expansion of the input vector, and returns the expansion result. The class inherits from the base expansion class (i.e., the transformation class in the module directory).
...
Notes
For input vector \(\mathbf{x} \in R^m\), its arc hyperbolic expansion can be represented as follows: $$ \begin{equation} \kappa (\mathbf{x}) = \left[ \text{arccosh}(\mathbf{x}), \text{arcsinh}(\mathbf{x}), \text{arctanh}(\mathbf{x}) \right] \in {R}^D, \end{equation} $$ where the output dimensions will be \(D = 3 m\).
By default, the input and output can also be processed with the optional pre- or post-processing functions in the arc hyperbolic expansion function.
Attributes:
Name | Type | Description |
---|---|---|
name |
str, default = 'arc_hyperbolic_expansion'
|
Name of the expansion function. |
Methods:
Name | Description |
---|---|
__init__ |
It performs the initialization of the expansion function. |
calculate_D |
It calculates the expansion space dimension D based on the input dimension parameter m. |
forward |
It implements the abstract forward method declared in the base expansion class. |
Source code in tinybig/expansion/trigonometric_expansion.py
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 |
|
__init__(name='arc_hyperbolic_expansion', *args, **kwargs)
The initialization method of the arc hyperbolic expansion function.
It initializes a arc hyperbolic expansion object based on the input function name. This method will also call the initialization method of the base class as well.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
name |
The name of the arc hyperbolic expansion function. |
'arc_hyperbolic_expansion'
|
Returns:
Type | Description |
---|---|
transformation
|
The arc hyperbolic expansion function. |
Source code in tinybig/expansion/trigonometric_expansion.py
calculate_D(m)
The expansion dimension calculation method.
It calculates the intermediate expansion space dimension based on the input dimension parameter m. For the arc hyperbolic expansion function, the expansion space dimension will be $$ D = 3m. $$
Parameters:
Name | Type | Description | Default |
---|---|---|---|
m |
int
|
The dimension of the input space. |
required |
Returns:
Type | Description |
---|---|
int
|
The dimension of the expansion space. |
Source code in tinybig/expansion/trigonometric_expansion.py
forward(x, device='cpu', *args, **kwargs)
The forward method of the data expansion function.
It performs the arc hyperbolic data expansion of the input data and returns the expansion result as $$ \begin{equation} \kappa (\mathbf{x}) = \left[ \text{arccosh}(\mathbf{x}), \text{arcsinh}(\mathbf{x}), \text{arctanh}(\mathbf{x}) \right] \in {R}^D. \end{equation} $$
Parameters:
Name | Type | Description | Default |
---|---|---|---|
x |
Tensor
|
The input data vector. |
required |
device |
The device to perform the data expansion. |
'cpu'
|
Returns:
Type | Description |
---|---|
Tensor
|
The expanded data vector of the input. |