org.bytedeco.dnnl

Class layer_normalization_forward.primitive_desc

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.dnnl.dnnl_primitive_desc_handle

org.bytedeco.dnnl.primitive_desc_base

org.bytedeco.dnnl.primitive_desc

org.bytedeco.dnnl.layer_normalization_forward.primitive_desc

All Implemented Interfaces:

AutoCloseable

Enclosing class:

layer_normalization_forward

public static class layer_normalization_forward.primitive_desc
extends primitive_desc

Primitive descriptor for a layer normalization forward propagation primitive.

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
primitive_desc() Default constructor.
primitive_desc(dnnl_primitive_desc pd) Constructs a primitive descriptor for a layer normalization forward propagation primitive from a C API primitive descriptor that must have a matching kind.
primitive_desc(engine aengine, dnnl.prop_kind aprop_kind, memory.desc src_desc, memory.desc dst_desc, float epsilon, dnnl.normalization_flags flags)
primitive_desc(engine aengine, dnnl.prop_kind aprop_kind, memory.desc src_desc, memory.desc dst_desc, float epsilon, dnnl.normalization_flags flags, primitive_attr attr, boolean allow_empty) Constructs a primitive descriptor for a layer normalization forward propagation primitive.
primitive_desc(engine aengine, dnnl.prop_kind aprop_kind, memory.desc src_desc, memory.desc dst_desc, memory.data_type scale_shift_data_type, float epsilon, dnnl.normalization_flags flags)
primitive_desc(engine aengine, dnnl.prop_kind aprop_kind, memory.desc src_desc, memory.desc dst_desc, memory.data_type scale_shift_data_type, float epsilon, dnnl.normalization_flags flags, primitive_attr attr, boolean allow_empty) Constructs a primitive descriptor for a layer normalization forward propagation primitive with a user-provided data type for the scale and shift memory objects.
primitive_desc(engine aengine, dnnl.prop_kind aprop_kind, memory.desc src_desc, memory.desc dst_desc, memory.desc stat_desc, float epsilon, dnnl.normalization_flags flags)
primitive_desc(engine aengine, dnnl.prop_kind aprop_kind, memory.desc src_desc, memory.desc dst_desc, memory.desc stat_desc, float epsilon, dnnl.normalization_flags flags, primitive_attr attr, boolean allow_empty) Constructs a primitive descriptor for a layer normalization forward propagation primitive.
primitive_desc(engine aengine, dnnl.prop_kind aprop_kind, memory.desc src_desc, memory.desc dst_desc, memory.desc stat_desc, memory.data_type scale_shift_data_type, float epsilon, dnnl.normalization_flags flags)
primitive_desc(engine aengine, dnnl.prop_kind aprop_kind, memory.desc src_desc, memory.desc dst_desc, memory.desc stat_desc, memory.data_type scale_shift_data_type, float epsilon, dnnl.normalization_flags flags, primitive_attr attr, boolean allow_empty) Constructs a primitive descriptor for a layer normalization forward propagation primitive with a user-provided data type for the scale and shift memory objects.
primitive_desc(engine aengine, int aprop_kind, memory.desc src_desc, memory.desc dst_desc, float epsilon, int flags)
primitive_desc(engine aengine, int aprop_kind, memory.desc src_desc, memory.desc dst_desc, float epsilon, int flags, primitive_attr attr, boolean allow_empty)
primitive_desc(engine aengine, int aprop_kind, memory.desc src_desc, memory.desc dst_desc, memory.data_type scale_shift_data_type, float epsilon, int flags)
primitive_desc(engine aengine, int aprop_kind, memory.desc src_desc, memory.desc dst_desc, memory.data_type scale_shift_data_type, float epsilon, int flags, primitive_attr attr, boolean allow_empty)
primitive_desc(engine aengine, int aprop_kind, memory.desc src_desc, memory.desc dst_desc, memory.desc stat_desc, float epsilon, int flags)
primitive_desc(engine aengine, int aprop_kind, memory.desc src_desc, memory.desc dst_desc, memory.desc stat_desc, float epsilon, int flags, primitive_attr attr, boolean allow_empty)
primitive_desc(engine aengine, int aprop_kind, memory.desc src_desc, memory.desc dst_desc, memory.desc stat_desc, memory.data_type scale_shift_data_type, float epsilon, int flags)
primitive_desc(engine aengine, int aprop_kind, memory.desc src_desc, memory.desc dst_desc, memory.desc stat_desc, memory.data_type scale_shift_data_type, float epsilon, int flags, primitive_attr attr, boolean allow_empty)
primitive_desc(long size) Native array allocator.
primitive_desc(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
memory.desc	dst_desc() \copydoc dnnl::primitive_desc_base::dst_desc()const
float	get_epsilon() \copydoc dnnl::primitive_desc_base::get_epsilon()const
dnnl.normalization_flags	get_flags() Returns normalization flags.
dnnl.prop_kind	get_prop_kind() \copydoc dnnl::primitive_desc_base::get_prop_kind()const
layer_normalization_forward.primitive_desc	getPointer(long i)
memory.desc	mean_desc() \copydoc dnnl::batch_normalization_forward::primitive_desc::mean_desc()const
layer_normalization_forward.primitive_desc	position(long position)
memory.desc	src_desc() \copydoc dnnl::primitive_desc_base::src_desc()const
memory.desc	variance_desc() \copydoc dnnl::batch_normalization_forward::primitive_desc::variance_desc()const
memory.desc	weights_desc() \copydoc dnnl::primitive_desc_base::weights_desc()const
memory.desc	workspace_desc() \copydoc dnnl::primitive_desc_base::workspace_desc()const

Methods inherited from class org.bytedeco.dnnl.primitive_desc

next_impl

Methods inherited from class org.bytedeco.dnnl.primitive_desc_base

diff_dst_desc, diff_dst_desc, diff_src_desc, diff_src_desc, diff_weights_desc, diff_weights_desc, dst_desc, get_activation_kind, get_algorithm, get_alpha, get_axis, get_beta, get_cache_blob_id, get_cell_kind, get_dilations, get_direction, get_engine, get_factors, get_group_size, get_k, get_kernel, get_kind, get_local_size, get_p, get_padding_l, get_padding_r, get_primitive_attr, get_strides, impl_info_str, query_md, query_md, query_md, query_md, query_s64, query_s64, scratchpad_desc, scratchpad_engine, src_desc, weights_desc

Methods inherited from class org.bytedeco.dnnl.dnnl_primitive_desc_handle

asBoolean, asDnnl_primitive_desc, equals, get, get, notEquals, put, reset, reset

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getDirectBufferAddress, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

primitive_desc

public primitive_desc(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

primitive_desc

public primitive_desc(long size)

Native array allocator. Access with Pointer.position(long).

primitive_desc

public primitive_desc()

Default constructor. Produces an empty object.

primitive_desc

public primitive_desc(@Const @ByRef
                      engine aengine,
                      dnnl.prop_kind aprop_kind,
                      @Const @ByRef
                      memory.desc src_desc,
                      @Const @ByRef
                      memory.desc dst_desc,
                      @Const @ByRef
                      memory.desc stat_desc,
                      float epsilon,
                      dnnl.normalization_flags flags,
                      @Const @ByRef(nullValue="dnnl::primitive_attr()")
                      primitive_attr attr,
                      @Cast(value="bool")
                      boolean allow_empty)

Constructs a primitive descriptor for a layer normalization forward propagation primitive.

Parameters:

aengine - Engine to use.

aprop_kind - Propagation kind. Possible values are #dnnl::prop_kind::forward_training, and #dnnl::prop_kind::forward_inference.

src_desc - Source memory descriptor.

dst_desc - Destination memory descriptor.

stat_desc - Statistics memory descriptors.

epsilon - Layer normalization epsilon parameter.

flags - Layer normalization flags (\ref dnnl::normalization_flags).

attr - Primitive attributes to use. Attributes are optional and default to empty attributes.

allow_empty - A flag signifying whether construction is allowed to fail without throwing an exception. In this case an empty object will be produced. This flag is optional and defaults to false.

primitive_desc

public primitive_desc(@Const @ByRef
                      engine aengine,
                      dnnl.prop_kind aprop_kind,
                      @Const @ByRef
                      memory.desc src_desc,
                      @Const @ByRef
                      memory.desc dst_desc,
                      @Const @ByRef
                      memory.desc stat_desc,
                      float epsilon,
                      dnnl.normalization_flags flags)

primitive_desc

public primitive_desc(@Const @ByRef
                      engine aengine,
                      @Cast(value="dnnl::prop_kind")
                      int aprop_kind,
                      @Const @ByRef
                      memory.desc src_desc,
                      @Const @ByRef
                      memory.desc dst_desc,
                      @Const @ByRef
                      memory.desc stat_desc,
                      float epsilon,
                      @Cast(value="dnnl::normalization_flags")
                      int flags,
                      @Const @ByRef(nullValue="dnnl::primitive_attr()")
                      primitive_attr attr,
                      @Cast(value="bool")
                      boolean allow_empty)

primitive_desc

public primitive_desc(@Const @ByRef
                      engine aengine,
                      @Cast(value="dnnl::prop_kind")
                      int aprop_kind,
                      @Const @ByRef
                      memory.desc src_desc,
                      @Const @ByRef
                      memory.desc dst_desc,
                      @Const @ByRef
                      memory.desc stat_desc,
                      float epsilon,
                      @Cast(value="dnnl::normalization_flags")
                      int flags)

primitive_desc

public primitive_desc(@Const @ByRef
                      engine aengine,
                      dnnl.prop_kind aprop_kind,
                      @Const @ByRef
                      memory.desc src_desc,
                      @Const @ByRef
                      memory.desc dst_desc,
                      float epsilon,
                      dnnl.normalization_flags flags,
                      @Const @ByRef(nullValue="dnnl::primitive_attr()")
                      primitive_attr attr,
                      @Cast(value="bool")
                      boolean allow_empty)

Constructs a primitive descriptor for a layer normalization forward propagation primitive.

Parameters:

aengine - Engine to use.

aprop_kind - Propagation kind. Possible values are #dnnl::prop_kind::forward_training, and #dnnl::prop_kind::forward_inference.

src_desc - Source memory descriptor.

dst_desc - Destination memory descriptor.

epsilon - Layer normalization epsilon parameter.

flags - Layer normalization flags (\ref dnnl::normalization_flags).

attr - Primitive attributes to use. Attributes are optional and default to empty attributes.

allow_empty - A flag signifying whether construction is allowed to fail without throwing an exception. In this case an empty object will be produced. This flag is optional and defaults to false.

primitive_desc

public primitive_desc(@Const @ByRef
                      engine aengine,
                      dnnl.prop_kind aprop_kind,
                      @Const @ByRef
                      memory.desc src_desc,
                      @Const @ByRef
                      memory.desc dst_desc,
                      float epsilon,
                      dnnl.normalization_flags flags)

primitive_desc

public primitive_desc(@Const @ByRef
                      engine aengine,
                      @Cast(value="dnnl::prop_kind")
                      int aprop_kind,
                      @Const @ByRef
                      memory.desc src_desc,
                      @Const @ByRef
                      memory.desc dst_desc,
                      float epsilon,
                      @Cast(value="dnnl::normalization_flags")
                      int flags,
                      @Const @ByRef(nullValue="dnnl::primitive_attr()")
                      primitive_attr attr,
                      @Cast(value="bool")
                      boolean allow_empty)

primitive_desc

public primitive_desc(@Const @ByRef
                      engine aengine,
                      @Cast(value="dnnl::prop_kind")
                      int aprop_kind,
                      @Const @ByRef
                      memory.desc src_desc,
                      @Const @ByRef
                      memory.desc dst_desc,
                      float epsilon,
                      @Cast(value="dnnl::normalization_flags")
                      int flags)

primitive_desc

public primitive_desc(@Const @ByRef
                      engine aengine,
                      dnnl.prop_kind aprop_kind,
                      @Const @ByRef
                      memory.desc src_desc,
                      @Const @ByRef
                      memory.desc dst_desc,
                      @Const @ByRef
                      memory.desc stat_desc,
                      memory.data_type scale_shift_data_type,
                      float epsilon,
                      dnnl.normalization_flags flags,
                      @Const @ByRef(nullValue="dnnl::primitive_attr()")
                      primitive_attr attr,
                      @Cast(value="bool")
                      boolean allow_empty)

Constructs a primitive descriptor for a layer normalization forward propagation primitive with a user-provided data type for the scale and shift memory objects.

Parameters:

aengine - Engine to use.

aprop_kind - Propagation kind. Possible values are #dnnl::prop_kind::forward_training, and #dnnl::prop_kind::forward_inference.

src_desc - Source memory descriptor.

dst_desc - Destination memory descriptor.

stat_desc - Statistics memory descriptors.

scale_shift_data_type - Data type of scale and shift memory. If neither scale nor shift flag are specified the parameter is ignored.

epsilon - Layer normalization epsilon parameter.

flags - Layer normalization flags (\ref dnnl::normalization_flags).

attr - Primitive attributes to use. Attributes are optional and default to empty attributes.

allow_empty - A flag signifying whether construction is allowed to fail without throwing an exception. In this case an empty object will be produced. This flag is optional and defaults to false.

primitive_desc

public primitive_desc(@Const @ByRef
                      engine aengine,
                      dnnl.prop_kind aprop_kind,
                      @Const @ByRef
                      memory.desc src_desc,
                      @Const @ByRef
                      memory.desc dst_desc,
                      @Const @ByRef
                      memory.desc stat_desc,
                      memory.data_type scale_shift_data_type,
                      float epsilon,
                      dnnl.normalization_flags flags)

primitive_desc

public primitive_desc(@Const @ByRef
                      engine aengine,
                      @Cast(value="dnnl::prop_kind")
                      int aprop_kind,
                      @Const @ByRef
                      memory.desc src_desc,
                      @Const @ByRef
                      memory.desc dst_desc,
                      @Const @ByRef
                      memory.desc stat_desc,
                      memory.data_type scale_shift_data_type,
                      float epsilon,
                      @Cast(value="dnnl::normalization_flags")
                      int flags,
                      @Const @ByRef(nullValue="dnnl::primitive_attr()")
                      primitive_attr attr,
                      @Cast(value="bool")
                      boolean allow_empty)

primitive_desc

public primitive_desc(@Const @ByRef
                      engine aengine,
                      @Cast(value="dnnl::prop_kind")
                      int aprop_kind,
                      @Const @ByRef
                      memory.desc src_desc,
                      @Const @ByRef
                      memory.desc dst_desc,
                      @Const @ByRef
                      memory.desc stat_desc,
                      memory.data_type scale_shift_data_type,
                      float epsilon,
                      @Cast(value="dnnl::normalization_flags")
                      int flags)

primitive_desc

public primitive_desc(@Const @ByRef
                      engine aengine,
                      dnnl.prop_kind aprop_kind,
                      @Const @ByRef
                      memory.desc src_desc,
                      @Const @ByRef
                      memory.desc dst_desc,
                      memory.data_type scale_shift_data_type,
                      float epsilon,
                      dnnl.normalization_flags flags,
                      @Const @ByRef(nullValue="dnnl::primitive_attr()")
                      primitive_attr attr,
                      @Cast(value="bool")
                      boolean allow_empty)

Constructs a primitive descriptor for a layer normalization forward propagation primitive with a user-provided data type for the scale and shift memory objects.

Parameters:

aengine - Engine to use.

aprop_kind - Propagation kind. Possible values are #dnnl::prop_kind::forward_training, and #dnnl::prop_kind::forward_inference.

src_desc - Source memory descriptor.

dst_desc - Destination memory descriptor.

scale_shift_data_type - Data type of scale and shift memory. If neither scale nor shift flag are specified the parameter is ignored.

epsilon - Layer normalization epsilon parameter.

flags - Layer normalization flags (\ref dnnl::normalization_flags).

attr - Primitive attributes to use. Attributes are optional and default to empty attributes.

allow_empty - A flag signifying whether construction is allowed to fail without throwing an exception. In this case an empty object will be produced. This flag is optional and defaults to false.

primitive_desc

public primitive_desc(@Const @ByRef
                      engine aengine,
                      dnnl.prop_kind aprop_kind,
                      @Const @ByRef
                      memory.desc src_desc,
                      @Const @ByRef
                      memory.desc dst_desc,
                      memory.data_type scale_shift_data_type,
                      float epsilon,
                      dnnl.normalization_flags flags)

primitive_desc

public primitive_desc(@Const @ByRef
                      engine aengine,
                      @Cast(value="dnnl::prop_kind")
                      int aprop_kind,
                      @Const @ByRef
                      memory.desc src_desc,
                      @Const @ByRef
                      memory.desc dst_desc,
                      memory.data_type scale_shift_data_type,
                      float epsilon,
                      @Cast(value="dnnl::normalization_flags")
                      int flags,
                      @Const @ByRef(nullValue="dnnl::primitive_attr()")
                      primitive_attr attr,
                      @Cast(value="bool")
                      boolean allow_empty)

primitive_desc

public primitive_desc(@Const @ByRef
                      engine aengine,
                      @Cast(value="dnnl::prop_kind")
                      int aprop_kind,
                      @Const @ByRef
                      memory.desc src_desc,
                      @Const @ByRef
                      memory.desc dst_desc,
                      memory.data_type scale_shift_data_type,
                      float epsilon,
                      @Cast(value="dnnl::normalization_flags")
                      int flags)

primitive_desc

public primitive_desc(dnnl_primitive_desc pd)

Constructs a primitive descriptor for a layer normalization forward propagation primitive from a C API primitive descriptor that must have a matching kind.

Parameters:

pd - C API primitive descriptor for a layer normalization forward propagation primitive.

Method Detail

position

public layer_normalization_forward.primitive_desc position(long position)

Overrides:

position in class primitive_desc

getPointer

public layer_normalization_forward.primitive_desc getPointer(long i)

Overrides:

getPointer in class primitive_desc

src_desc

@ByVal
public memory.desc src_desc()

\copydoc dnnl::primitive_desc_base::src_desc()const

Overrides:

src_desc in class primitive_desc_base

Returns:

Source memory descriptor.

dst_desc

@ByVal
public memory.desc dst_desc()

\copydoc dnnl::primitive_desc_base::dst_desc()const

Overrides:

dst_desc in class primitive_desc_base

Returns:

Destination memory descriptor.

weights_desc

@ByVal
public memory.desc weights_desc()

\copydoc dnnl::primitive_desc_base::weights_desc()const

Overrides:

weights_desc in class primitive_desc_base

Returns:

Weights memory descriptor.

workspace_desc

@ByVal
public memory.desc workspace_desc()

\copydoc dnnl::primitive_desc_base::workspace_desc()const

Overrides:

workspace_desc in class primitive_desc_base

Returns:

Workspace memory descriptor.

mean_desc

@ByVal
public memory.desc mean_desc()

\copydoc dnnl::batch_normalization_forward::primitive_desc::mean_desc()const

variance_desc

@ByVal
public memory.desc variance_desc()

\copydoc dnnl::batch_normalization_forward::primitive_desc::variance_desc()const

get_prop_kind

public dnnl.prop_kind get_prop_kind()

\copydoc dnnl::primitive_desc_base::get_prop_kind()const

Overrides:

get_prop_kind in class primitive_desc_base

Returns:

A propagation kind.

get_epsilon

public float get_epsilon()

\copydoc dnnl::primitive_desc_base::get_epsilon()const

Overrides:

get_epsilon in class primitive_desc_base

Returns:

An epsilon.

get_flags

public dnnl.normalization_flags get_flags()

Returns normalization flags.

Returns:

Normalization flags.