Intel® oneAPI Data Analytics Library Developer Guide and Reference
A newer version of this document is available. Customers should click here to go to the newest version.
Visible to Intel only — GUID: GUID-149ED1A7-3009-4A92-B317-EF06D433BA99
Visible to Intel only — GUID: GUID-149ED1A7-3009-4A92-B317-EF06D433BA99
Sigmoid kernel
The Sigmoid kernel is a popular kernel function used in kernelized learning algorithms.
Operation |
Computational methods |
Programming Interface |
||
Mathematical formulation
Refer to Developer Guide: Sigmoid kernel.
Programming Interface
All types and functions in this section are declared in the oneapi::dal::sigmoid_kernel namespace and are available via inclusion of the oneapi/dal/algo/sigmoid_kernel.hpp header file.
Descriptor
template<typenameFloat=float,typenameMethod=method::by_default,typenameTask=task::by_default>classdescriptor
- Template Parameters
Constructors
descriptor()=default
Creates a new instance of the class with the default property values.
Properties
doubleshift
The coefficient
- Getter & Setter
-
double get_shift() const
auto & set_shift(double value)
doublescale
The coefficient
- Getter & Setter
-
double get_scale() const
auto & set_scale(double value)
Method tags
structdense
usingby_default=dense
Alias tag-type for the dense method.
Task tags
structcompute
Tag-type that parameterizes entities that are used to compute statistics, distance, and so on.
usingby_default=compute
Alias tag-type for the compute task.
Training compute(...)
Input
template<typenameTask=task::by_default>classcompute_input
- Template Parameters
-
Task – Tag-type that specifies the type of the problem to solve. Can be task::compute.
Constructors
compute_input(consttable&x, consttable&y)
Creates a new instance of the class with the given x and y.
Properties
consttable&y
An
- Getter & Setter
-
const table & get_y() const
auto & set_y(const table &data)
consttable&x
An
- Getter & Setter
-
const table & get_x() const
auto & set_x(const table &data)
Result
template<typenameTask=task::by_default>classcompute_result
- Template Parameters
-
Task – Tag-type that specifies the type of the problem to solve. Can be task::compute.
Constructors
compute_result()
Creates a new instance of the class with the default property values.
Properties
consttable&values
An
- Getter & Setter
-
const table & get_values() const
auto & set_values(const table &value)
Operation
template<typenameDescriptor>sigmoid_kernel::compute_resultcompute(constDescriptor&desc, constsigmoid_kernel::compute_input&input)
- Parameters
-
desc – Sigmoid Kernel algorithm descriptor sigmoid_kernel::descriptor
input – Input data for the computing operation