Package apple.metalperformanceshaders

Class 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. API-Since: 11.3

    • Constructor Detail

      • MPSCNNLossLabels

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

    • Method Detail

      • accessInstanceVariablesDirectly

        public static boolean accessInstanceVariablesDirectly()

      • allocWithZone

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

      • automaticallyNotifiesObserversForKey

        public static boolean automaticallyNotifiesObserversForKey​(@NotNull
                                                           @NotNull java.lang.String key)

      • cancelPreviousPerformRequestsWithTarget

        public static void cancelPreviousPerformRequestsWithTarget​(@NotNull
                                                           @NotNull java.lang.Object aTarget)

      • cancelPreviousPerformRequestsWithTargetSelectorObject

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

      • classFallbacksForKeyedArchiver

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

      • classForKeyedUnarchiver

        @NotNull
public static @NotNull 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()

      • initWithDeviceLabelsDescriptor

        public MPSCNNLossLabels initWithDeviceLabelsDescriptor​(@NotNull
                                                       @NotNull MTLDevice device,
                                                       @NotNull
                                                       @NotNull 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​(@NotNull
                                                                                     @NotNull MTLDevice device,
                                                                                     MTLSize lossImageSize,
                                                                                     @NotNull
                                                                                     @NotNull MPSCNNLossDataDescriptor labelsDescriptor,
                                                                                     @Nullable
                                                                                     @Nullable 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​(@NotNull
                                                                           @NotNull MTLDevice device,
                                                                           MTLSize lossImageSize,
                                                                           @NotNull
                                                                           @NotNull MPSImage labelsImage,
                                                                           @Nullable
                                                                           @Nullable 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. API-Since: 13.0

      • initWithDeviceResourceList

        public MPSCNNLossLabels initWithDeviceResourceList​(@NotNull
                                                   @NotNull MTLDevice device,
                                                   @NotNull
                                                   @NotNull 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. API-Since: 11.3

      • initWithResource

        public MPSCNNLossLabels initWithResource​(@Nullable
                                         @Nullable 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​(@Nullable
                                          @Nullable 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

      • 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

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

      • labelsImage

        @NotNull
public @NotNull 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

        @NotNull
public @NotNull 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.

      • 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

        @NotNull
public static @NotNull MPSCNNLossLabels temporaryStateWithCommandBuffer​(@NotNull
                                                                        @NotNull MTLCommandBuffer cmdBuf)

      • temporaryStateWithCommandBufferBufferSize

        @NotNull
public static @NotNull MPSCNNLossLabels temporaryStateWithCommandBufferBufferSize​(@NotNull
                                                                                  @NotNull MTLCommandBuffer cmdBuf,
                                                                                  long bufferSize)

      • version_static

        public static long version_static()

      • weightsImage

        @NotNull
public @NotNull 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.

      • useStoredAccessor

        @Deprecated
public static boolean useStoredAccessor()
        Deprecated.