apple.metalperformanceshaders

Class MPSCNNLossLabels

java.lang.Object

org.moe.natj.general.NativeObject

org.moe.natj.objc.ObjCObject

apple.NSObject

apple.metalperformanceshaders.MPSState

apple.metalperformanceshaders.MPSCNNLossLabels

All Implemented Interfaces:

NSObject

public class MPSCNNLossLabels
extends MPSState

MPSCNNLossLabels [@dependency] This depends on Metal.framework.

The MPSCNNLossLabels is used to hold the per-element weights buffer used by both MPSCNNLoss forward filter and MPSNNLossGradient backward filter. The MPSCNNLoss forward filter populates the MPSCNNLossLabels object and the MPSNNLossGradient backward filter consumes the state object.

Nested Class Summary

Nested classes/interfaces inherited from class apple.NSObject

NSObject.Function_instanceMethodForSelector_ret, NSObject.Function_methodForSelector_ret

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MPSCNNLossLabels(org.moe.natj.general.Pointer peer)

Method Summary

Modifier and Type	Method and Description
static boolean	accessInstanceVariablesDirectly()
static MPSCNNLossLabels	alloc()
static MPSCNNLossLabels	allocWithZone(org.moe.natj.general.ptr.VoidPtr zone)
static boolean	automaticallyNotifiesObserversForKey(java.lang.String key)
static void	cancelPreviousPerformRequestsWithTarget(java.lang.Object aTarget)
static void	cancelPreviousPerformRequestsWithTargetSelectorObject(java.lang.Object aTarget, org.moe.natj.objc.SEL aSelector, java.lang.Object anArgument)
static NSArray<java.lang.String>	classFallbacksForKeyedArchiver()
static org.moe.natj.objc.Class	classForKeyedUnarchiver()
static java.lang.String	debugDescription_static()
static java.lang.String	description_static()
static long	hash_static()
MPSCNNLossLabels	init()
MPSCNNLossLabels	initWithDeviceBufferSize(MTLDevice device, long bufferSize)
MPSCNNLossLabels	initWithDeviceLabelsDescriptor(MTLDevice device, MPSCNNLossDataDescriptor labelsDescriptor) Set labels (aka targets, ground truth) for the MPSCNNLossLabels object.
MPSCNNLossLabels	initWithDeviceLossImageSizeLabelsDescriptorWeightsDescriptor(MTLDevice device, MTLSize lossImageSize, MPSCNNLossDataDescriptor labelsDescriptor, MPSCNNLossDataDescriptor weightsDescriptor) Set labels (aka targets, ground truth) and weights for the MPSCNNLossLabels object.
MPSCNNLossLabels	initWithDeviceLossImageSizeLabelsImageWeightsImage(MTLDevice device, MTLSize lossImageSize, MPSImage labelsImage, MPSImage weightsImage) Set labels (aka targets, ground truth) and weights for the MPSCNNLossLabels object.
MPSCNNLossLabels	initWithDeviceResourceList(MTLDevice device, MPSStateResourceList resourceList) Initialize a non-temporary state to hold a number of textures and buffers
MPSCNNLossLabels	initWithDeviceTextureDescriptor(MTLDevice device, MTLTextureDescriptor descriptor)
MPSCNNLossLabels	initWithResource(MTLResource resource) Create a MPSState with a non-temporary MTLResource
MPSCNNLossLabels	initWithResources(NSArray<?> resources) Create a state object with a list of MTLResources
static NSObject.Function_instanceMethodForSelector_ret	instanceMethodForSelector(org.moe.natj.objc.SEL aSelector)
static NSMethodSignature	instanceMethodSignatureForSelector(org.moe.natj.objc.SEL aSelector)
static boolean	instancesRespondToSelector(org.moe.natj.objc.SEL aSelector)
static boolean	isSubclassOfClass(org.moe.natj.objc.Class aClass)
static NSSet<java.lang.String>	keyPathsForValuesAffectingValueForKey(java.lang.String key)
MPSImage	labelsImage() Labels image accessor method.
MPSImage	lossImage() Loss image accessor method.
static MPSCNNLossLabels	new_objc()
static boolean	resolveClassMethod(org.moe.natj.objc.SEL sel)
static boolean	resolveInstanceMethod(org.moe.natj.objc.SEL sel)
static void	setVersion_static(long aVersion)
static org.moe.natj.objc.Class	superclass_static()
static MPSCNNLossLabels	temporaryStateWithCommandBuffer(MTLCommandBuffer cmdBuf)
static MPSCNNLossLabels	temporaryStateWithCommandBufferBufferSize(MTLCommandBuffer cmdBuf, long bufferSize)
static MPSCNNLossLabels	temporaryStateWithCommandBufferResourceList(MTLCommandBuffer commandBuffer, MPSStateResourceList resourceList)
static MPSCNNLossLabels	temporaryStateWithCommandBufferTextureDescriptor(MTLCommandBuffer cmdBuf, MTLTextureDescriptor descriptor)
static long	version_static()
MPSImage	weightsImage() Weights image accessor method.

Methods inherited from class apple.metalperformanceshaders.MPSState

bufferSizeAtIndex, destinationImageDescriptorForSourceImagesSourceStatesForKernelSuggestedDescriptor, isTemporary, label, readCount, resource, resourceAtIndexAllocateMemory, resourceCount, resourceSize, resourceTypeAtIndex, setLabel, setReadCount, synchronizeOnCommandBuffer, textureInfoAtIndex

Methods inherited from class apple.NSObject

accessibilityActivate, accessibilityActivationPoint, accessibilityAssistiveTechnologyFocusedIdentifiers, accessibilityAttributedHint, accessibilityAttributedLabel, accessibilityAttributedUserInputLabels, accessibilityAttributedValue, accessibilityContainerType, accessibilityCustomActions, accessibilityCustomRotors, accessibilityDecrement, accessibilityDragSourceDescriptors, accessibilityDropPointDescriptors, accessibilityElementAtIndex, accessibilityElementCount, accessibilityElementDidBecomeFocused, accessibilityElementDidLoseFocus, accessibilityElementIsFocused, accessibilityElements, accessibilityElementsHidden, accessibilityFrame, accessibilityHint, accessibilityIncrement, accessibilityLabel, accessibilityLanguage, accessibilityNavigationStyle, accessibilityPath, accessibilityPerformEscape, accessibilityPerformMagicTap, accessibilityRespondsToUserInteraction, accessibilityScroll, accessibilityTextualContext, accessibilityTraits, accessibilityUserInputLabels, accessibilityValue, accessibilityViewIsModal, addObserverForKeyPathOptionsContext, attemptRecoveryFromErrorOptionIndex, attemptRecoveryFromErrorOptionIndexDelegateDidRecoverSelectorContextInfo, autoContentAccessingProxy, awakeAfterUsingCoder, awakeFromNib, class_objc, classForCoder, classForKeyedArchiver, copy, dealloc, debugDescription, description, dictionaryWithValuesForKeys, didChangeValueForKey, didChangeValueForKeyWithSetMutationUsingObjects, didChangeValuesAtIndexesForKey, doesNotRecognizeSelector, fileManagerShouldProceedAfterError, fileManagerWillProcessPath, finalize_objc, forwardingTargetForSelector, forwardInvocation, hash, indexOfAccessibilityElement, isAccessibilityElement, isEqual, isKindOfClass, isMemberOfClass, isProxy, methodForSelector, methodSignatureForSelector, mutableArrayValueForKey, mutableArrayValueForKeyPath, mutableCopy, mutableOrderedSetValueForKey, mutableOrderedSetValueForKeyPath, mutableSetValueForKey, mutableSetValueForKeyPath, observationInfo, observeValueForKeyPathOfObjectChangeContext, performSelector, performSelectorInBackgroundWithObject, performSelectorOnMainThreadWithObjectWaitUntilDone, performSelectorOnMainThreadWithObjectWaitUntilDoneModes, performSelectorOnThreadWithObjectWaitUntilDone, performSelectorOnThreadWithObjectWaitUntilDoneModes, performSelectorWithObject, performSelectorWithObjectAfterDelay, performSelectorWithObjectAfterDelayInModes, performSelectorWithObjectWithObject, prepareForInterfaceBuilder, provideImageDataBytesPerRowOrigin_Size_UserInfo, removeObserverForKeyPath, removeObserverForKeyPathContext, replacementObjectForCoder, replacementObjectForKeyedArchiver, respondsToSelector, self, setAccessibilityActivationPoint, setAccessibilityAttributedHint, setAccessibilityAttributedLabel, setAccessibilityAttributedUserInputLabels, setAccessibilityAttributedValue, setAccessibilityContainerType, setAccessibilityCustomActions, setAccessibilityCustomRotors, setAccessibilityDragSourceDescriptors, setAccessibilityDropPointDescriptors, setAccessibilityElements, setAccessibilityElementsHidden, setAccessibilityFrame, setAccessibilityHint, setAccessibilityLabel, setAccessibilityLanguage, setAccessibilityNavigationStyle, setAccessibilityPath, setAccessibilityRespondsToUserInteraction, setAccessibilityTextualContext, setAccessibilityTraits, setAccessibilityUserInputLabels, setAccessibilityValue, setAccessibilityViewIsModal, setIsAccessibilityElement, setNilValueForKey, setObservationInfo, setShouldGroupAccessibilityChildren, setValueForKey, setValueForKeyPath, setValueForUndefinedKey, setValuesForKeysWithDictionary, shouldGroupAccessibilityChildren, superclass, validateValueForKeyError, validateValueForKeyPathError, valueForKey, valueForKeyPath, valueForUndefinedKey, willChangeValueForKey, willChangeValueForKeyWithSetMutationUsingObjects, willChangeValuesAtIndexesForKey

Methods inherited from class org.moe.natj.objc.ObjCObject

equals, toString

Methods inherited from class org.moe.natj.general.NativeObject

finalize, getPeer, getPeerPointer

Methods inherited from class java.lang.Object

clone, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MPSCNNLossLabels

protected MPSCNNLossLabels(org.moe.natj.general.Pointer peer)

Method Detail

accessInstanceVariablesDirectly

public static boolean accessInstanceVariablesDirectly()

alloc

public static MPSCNNLossLabels alloc()

allocWithZone

public static MPSCNNLossLabels allocWithZone(org.moe.natj.general.ptr.VoidPtr zone)

automaticallyNotifiesObserversForKey

public static boolean automaticallyNotifiesObserversForKey(java.lang.String key)

cancelPreviousPerformRequestsWithTarget

public static void cancelPreviousPerformRequestsWithTarget(java.lang.Object aTarget)

cancelPreviousPerformRequestsWithTargetSelectorObject

public static void cancelPreviousPerformRequestsWithTargetSelectorObject(java.lang.Object aTarget,
                                                                         org.moe.natj.objc.SEL aSelector,
                                                                         java.lang.Object anArgument)

classFallbacksForKeyedArchiver

public static NSArray<java.lang.String> classFallbacksForKeyedArchiver()

classForKeyedUnarchiver

public static org.moe.natj.objc.Class classForKeyedUnarchiver()

debugDescription_static

public static java.lang.String debugDescription_static()

description_static

public static java.lang.String description_static()

hash_static

public static long hash_static()

init

public MPSCNNLossLabels init()

Overrides:

init in class MPSState

initWithDeviceBufferSize

public MPSCNNLossLabels initWithDeviceBufferSize(MTLDevice device,
                                                 long bufferSize)

Overrides:

initWithDeviceBufferSize in class MPSState

initWithDeviceLabelsDescriptor

public MPSCNNLossLabels initWithDeviceLabelsDescriptor(MTLDevice device,
                                                       MPSCNNLossDataDescriptor labelsDescriptor)

Set labels (aka targets, ground truth) for the MPSCNNLossLabels object.

The labels and weights data are copied into internal storage. The computed loss can either be a scalar value (in batch mode, a single value per image in a batch) or it can be one value per feature channel. Thus, the size of the loss image must either match the size of the input source image or be {1, 1, 1}, which results in a scalar value. In this convinience initializer, the assumed size of the loss image is {1, 1, 1}.

Parameters:

device - Device the state resources will be created on.

labelsDescriptor - Describes the labels data. This includes: - The per-element labels data. The data must be in floating point format. - Data layout of labels data. See MPSImage.h for more information. - Size of labels data: (width, height, feature channels}. - Optionally, row bytes of labels data. - Optionally, slice bytes of labels data.

initWithDeviceLossImageSizeLabelsDescriptorWeightsDescriptor

public MPSCNNLossLabels initWithDeviceLossImageSizeLabelsDescriptorWeightsDescriptor(MTLDevice device,
                                                                                     MTLSize lossImageSize,
                                                                                     MPSCNNLossDataDescriptor labelsDescriptor,
                                                                                     MPSCNNLossDataDescriptor weightsDescriptor)

Set labels (aka targets, ground truth) and weights for the MPSCNNLossLabels object. Weights are optional.

The labels and weights data are copied into internal storage.

Parameters:

device - Device the state resources will be created on.

lossImageSize - The size of the resulting loss image: { width, height, featureChannels }. The computed loss can either be a scalar value (in batch mode, a single value per image in a batch) or it can be one value per feature channel. Thus, the size of the loss image must either match the size of the input source image or be {1, 1, 1}, which results in a scalar value.

labelsDescriptor - Describes the labels data. This includes: - The per-element labels data. The data must be in floating point format. - Data layout of labels data. See MPSImage.h for more information. - Size of labels data: (width, height, feature channels}. - Optionally, row bytes of labels data. - Optionally, slice bytes of labels data.

weightsDescriptor - Describes the weights data. This includes: - The per-element weights data. The data must be in floating point format. - Data layout of weights data. See MPSImage.h for more information. - Size of weights data: (width, height, feature channels}. - Optionally, row bytes of weights data. - Optionally, slice bytes of weights data. This parameter is optional. If you are using a single weight, please use the weight property of the MPSCNNLossDescriptor object.

initWithDeviceLossImageSizeLabelsImageWeightsImage

public MPSCNNLossLabels initWithDeviceLossImageSizeLabelsImageWeightsImage(MTLDevice device,
                                                                           MTLSize lossImageSize,
                                                                           MPSImage labelsImage,
                                                                           MPSImage weightsImage)

Set labels (aka targets, ground truth) and weights for the MPSCNNLossLabels object. Weights are optional.

The labels and weights images are retained - it is the users responsibility to make sure that they contain the right data when the loss filter is run on the device.

Parameters:

device - Device the state resources will be created on.

lossImageSize - The size of the resulting loss image: { width, height, featureChannels }. The computed loss can either be a scalar value (in batch mode, a single value per image in a batch) or it can be one value per feature channel. Thus, the size of the loss image must either match the size of the input source image or be {1, 1, 1}, which results in a scalar value.

labelsImage - Describes the labels data.

weightsImage - Describes the weights data. This parameter is optional. If you are using a single weight, please use the weight property of the MPSCNNLossDescriptor object.

initWithDeviceResourceList

public MPSCNNLossLabels initWithDeviceResourceList(MTLDevice device,
                                                   MPSStateResourceList resourceList)

Description copied from class: MPSState

Initialize a non-temporary state to hold a number of textures and buffers

The allocation of each resource will be deferred until it is needed. This occurs when -resource or -resourceAtIndex: is called.

Overrides:

initWithDeviceResourceList in class MPSState

resourceList - The list of resources to create.

initWithDeviceTextureDescriptor

public MPSCNNLossLabels initWithDeviceTextureDescriptor(MTLDevice device,
                                                        MTLTextureDescriptor descriptor)

Overrides:

initWithDeviceTextureDescriptor in class MPSState

initWithResource

public MPSCNNLossLabels initWithResource(MTLResource resource)

Description copied from class: MPSState

Create a MPSState with a non-temporary MTLResource

Overrides:

initWithResource in class MPSState

Parameters:

resource - A MTLBuffer or MTLTexture. May be nil.

initWithResources

public MPSCNNLossLabels initWithResources(NSArray<?> resources)

Description copied from class: MPSState

Create a state object with a list of MTLResources

Because MPS prefers deferred allocation of resources your application should use -initWithTextures:bufferSizes:bufferCount: whenever possible. This method is useful for cases when the MTLResources must be initialized by the CPU.

Overrides:

initWithResources in class MPSState

instanceMethodForSelector

public static NSObject.Function_instanceMethodForSelector_ret instanceMethodForSelector(org.moe.natj.objc.SEL aSelector)

instanceMethodSignatureForSelector

public static NSMethodSignature instanceMethodSignatureForSelector(org.moe.natj.objc.SEL aSelector)

instancesRespondToSelector

public static boolean instancesRespondToSelector(org.moe.natj.objc.SEL aSelector)

isSubclassOfClass

public static boolean isSubclassOfClass(org.moe.natj.objc.Class aClass)

keyPathsForValuesAffectingValueForKey

public static NSSet<java.lang.String> keyPathsForValuesAffectingValueForKey(java.lang.String key)

labelsImage

public MPSImage labelsImage()

Labels image accessor method.

Returns:

An autoreleased MPSImage object, containing the labels data. The labels data is populated in the -initWithDevice call.

In order to guarantee that the image is correctly synchronized for CPU side access, it is the application's responsibility to call the [gradientState synchronizeOnCommandBuffer:] method before accessing the data in the image.

lossImage

public MPSImage lossImage()

Loss image accessor method.

Returns:

An autoreleased MPSImage object, containing the loss data. The loss data is populated in the -encode call, thus the contents are undefined until you -encode the filter.

In order to guarantee that the image is correctly synchronized for CPU side access, it is the application's responsibility to call the [gradientState synchronizeOnCommandBuffer:] method before accessing the data in the image.

new_objc

public static MPSCNNLossLabels new_objc()

resolveClassMethod

public static boolean resolveClassMethod(org.moe.natj.objc.SEL sel)

resolveInstanceMethod

public static boolean resolveInstanceMethod(org.moe.natj.objc.SEL sel)

setVersion_static

public static void setVersion_static(long aVersion)

superclass_static

public static org.moe.natj.objc.Class superclass_static()

temporaryStateWithCommandBuffer

public static MPSCNNLossLabels temporaryStateWithCommandBuffer(MTLCommandBuffer cmdBuf)

temporaryStateWithCommandBufferBufferSize

public static MPSCNNLossLabels temporaryStateWithCommandBufferBufferSize(MTLCommandBuffer cmdBuf,
                                                                         long bufferSize)

temporaryStateWithCommandBufferResourceList

public static MPSCNNLossLabels temporaryStateWithCommandBufferResourceList(MTLCommandBuffer commandBuffer,
                                                                           MPSStateResourceList resourceList)

temporaryStateWithCommandBufferTextureDescriptor

public static MPSCNNLossLabels temporaryStateWithCommandBufferTextureDescriptor(MTLCommandBuffer cmdBuf,
                                                                                MTLTextureDescriptor descriptor)

version_static

public static long version_static()

weightsImage

public MPSImage weightsImage()

Weights image accessor method.

Returns:

An autoreleased MPSImage object, containing the weights data. The weights data is populated in the -initWithDevice call.

In order to guarantee that the image is correctly synchronized for CPU side access, it is the application's responsibility to call the [gradientState synchronizeOnCommandBuffer:] method before accessing the data in the image.