MPSCNNInstanceNormalizationGradientState(3)

NAME
MPSCNNInstanceNormalizationGradientState

SYNOPSIS

#import <MPSCNNInstanceNormalization.h>

Inherits MPSNNGradientState.

  Instance Methods
(nonnull instancetype) - initWithDevice:textureDescriptor:
(nonnull instancetype) - initWithResource:
(nonnull instancetype) - initWithDevice:bufferSize:

  Class Methods
(nonnull instancetype) + temporaryStateWithCommandBuffer:textureDescriptor:
(nonnull instancetype) + temporaryStateWithCommandBuffer:
(nonnull instancetype) + temporaryStateWithCommandBuffer:bufferSize:

  Properties
MPSCNNInstanceNormalization * instanceNormalization
__nullable id< MTLBuffer > gamma
__nullable id< MTLBuffer > beta
__nonnull id< MTLBuffer > gradientForGamma
__nonnull id< MTLBuffer > gradientForBeta

Detailed Description

This depends on Metal.framework A state to hold information necessary to execute a gradient pass for MPSCNNInstanceNormalization. Gradient states should be created by using the forward kernel's methods. This will ensure that the state captures all information necessary to execute the corresponding gradient pass.

Method Documentation

  - (nonnull instancetype) initWithDevice: (__nonnull id< MTLDevice >) device(size_t) bufferSize

Reimplemented from MPSState.

  - (nonnull instancetype) initWithDevice: (__nonnull id< MTLDevice >) device(MTLTextureDescriptor *__nonnull) descriptor
Unavailable. Use MPSCNNInstanceNormalization state creation methods.

Reimplemented from MPSState.

  - (nonnull instancetype) initWithResource: (__nullable id< MTLResource >) resource
Unavailable. Use MPSCNNInstanceNormalization state creation methods.

Reimplemented from MPSState.

  + (nonnull instancetype) temporaryStateWithCommandBuffer: (__nonnull id< MTLCommandBuffer >) cmdBuf
Create a new autoreleased temporary state object without underlying resource

Parameters:
    cmdBuf The command buffer with which the temporary resource is associated

Reimplemented from MPSState.

  + (nonnull instancetype) temporaryStateWithCommandBuffer: (__nonnull id< MTLCommandBuffer >) cmdBuf(size_t) bufferSize
Create a MPSState holding a temporary MTLBuffer

Parameters:
    cmdBuf The command buffer against which the temporary resource is allocated
    bufferSize The size of the buffer in bytes

Reimplemented from MPSState.

  + (nonnull instancetype) temporaryStateWithCommandBuffer: (__nonnull id< MTLCommandBuffer >) cmdBuf(MTLTextureDescriptor *__nonnull) descriptor
Unavailable. Use MPSCNNInstanceNormalization state creation methods.

Reimplemented from MPSState.

Property Documentation

  - (The MTLBuffer containing the gradient values for) beta [read], [nonatomic], [assign]
Return an MTLBuffer object with the state's current beta values..

  - (The MTLBuffer containing the gradient values for) gamma [read], [nonatomic], [assign]
Return an MTLBuffer object with the state's current gamma values.

  - (__nonnull id<MTLBuffer>) gradientForBeta [read], [nonatomic], [assign]

  - (__nonnull id<MTLBuffer>) gradientForGamma [read], [nonatomic], [assign]

  - (MPSCNNInstanceNormalization*) instanceNormalization [read], [nonatomic], [retain]
The MPSCNNInstanceNormalization object that created this state object.

Author

Generated automatically by Doxygen for MetalPerformanceShaders.framework from the source code.