MLParameterKey (moe.platform.ios API)

java.lang.Object
- org.moe.natj.general.NativeObject
- - org.moe.natj.objc.ObjCObject
  - - apple.NSObject
    - - apple.coreml.MLKey
      - apple.coreml.MLParameterKey

All Implemented Interfaces:

NSCoding, NSCopying, NSSecureCoding, NSObject
```
public class MLParameterKey
extends MLKey
```
A class to specify list of supported model update parameters.

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 MLParameterKey(org.moe.natj.general.Pointer peer)

Constructors
Modifier	Constructor and Description
`protected`	`MLParameterKey(org.moe.natj.general.Pointer peer)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`_supportsSecureCoding()` This property must return YES on all classes that allow secure coding.
`static boolean`	`accessInstanceVariablesDirectly()`
`static MLParameterKey`	`alloc()`
`static MLParameterKey`	`allocWithZone(org.moe.natj.general.ptr.VoidPtr zone)`
`static boolean`	`automaticallyNotifiesObserversForKey(java.lang.String key)`
`static MLParameterKey`	`beta1()` Double parameter used to control the beta1 of Adam optimizer.
`static MLParameterKey`	`beta2()` Double parameter used to control the beta2 of Adam optimizer.
`static MLParameterKey`	`biases()` MLMultiArray parameter returned when client requests for biases of a particular layer using a scoped parameter.
`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 MLParameterKey`	`epochs()` Int64 parameter used to specify the number of epochs used by optimizer.
`static MLParameterKey`	`eps()` Double parameter used to control the epsilon of Adam optimizer.
`static long`	`hash_static()`
`MLParameterKey`	`init()`
`MLParameterKey`	`initWithCoder(NSCoder coder)` NS_DESIGNATED_INITIALIZER
`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)`
`static MLParameterKey`	`learningRate()` Double parameter used to control the learning rate of an optimizer.
`static MLParameterKey`	`linkedModelFileName()` String parameter used to specify the name of a linked model
`static MLParameterKey`	`linkedModelSearchPath()` String parameteru sed to specify the search path for a linked model
`static MLParameterKey`	`miniBatchSize()` Int64 parameter used to specify the size of a miniBatch used by optimizer.
`static MLParameterKey`	`momentum()` Double parameter used to control the momentum of gradient based optimizers.
`static MLParameterKey`	`new_objc()`
`static MLParameterKey`	`numberOfNeighbors()` Int64 parameter used to specify the number of neighbors to use for class affinity (applicable to kNN).
`static boolean`	`resolveClassMethod(org.moe.natj.objc.SEL sel)`
`static boolean`	`resolveInstanceMethod(org.moe.natj.objc.SEL sel)`
`MLParameterKey`	`scopedTo(java.lang.String scope)` Returns a new MLParameterKey instance after adding additional scoping
`static MLParameterKey`	`seed()` Int64 parameter used to specify the seed to be used if shuffling data between epochs.
`static void`	`setVersion_static(long aVersion)`
`static MLParameterKey`	`shuffle()` Bool parameter used to specify whether to shuffle the data between epochs.
`static org.moe.natj.objc.Class`	`superclass_static()`
`static boolean`	`supportsSecureCoding()`
`static long`	`version_static()`
`static MLParameterKey`	`weights()` MLMultiArray parameter returned when client requests for weights of a particular layer using a scoped parameter.

Methods inherited from class apple.coreml.MLKey
copyWithZone, encodeWithCoder, name, scope

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
  - MLParameterKey
```
protected MLParameterKey(org.moe.natj.general.Pointer peer)
```
- Method Detail
  - accessInstanceVariablesDirectly
```
public static boolean accessInstanceVariablesDirectly()
```
  - alloc
```
public static MLParameterKey alloc()
```
  - allocWithZone
```
public static MLParameterKey allocWithZone(org.moe.natj.general.ptr.VoidPtr zone)
```
  - automaticallyNotifiesObserversForKey
```
public static boolean automaticallyNotifiesObserversForKey(java.lang.String key)
```
  - beta1
```
public static MLParameterKey beta1()
```
    Double parameter used to control the beta1 of Adam optimizer. Adjustable at load-time
  - beta2
```
public static MLParameterKey beta2()
```
    Double parameter used to control the beta2 of Adam optimizer. Adjustable at load-time
  - biases
```
public static MLParameterKey biases()
```
    MLMultiArray parameter returned when client requests for biases of a particular layer using a scoped parameter.
  - 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()
```
  - epochs
```
public static MLParameterKey epochs()
```
    Int64 parameter used to specify the number of epochs used by optimizer. Adjustable at load-time
  - eps
```
public static MLParameterKey eps()
```
    Double parameter used to control the epsilon of Adam optimizer. Adjustable at load-time
  - hash_static
```
public static long hash_static()
```
  - init
```
public MLParameterKey init()
```
    Overrides:
    
    init in class MLKey
  - initWithCoder
```
public MLParameterKey initWithCoder(NSCoder coder)
```
    Description copied from interface: NSCoding
    
    NS_DESIGNATED_INITIALIZER
    
    Specified by:
    
    initWithCoder in interface NSCoding
    
    Overrides:
    
    initWithCoder in class MLKey
  - 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)
```
  - learningRate
```
public static MLParameterKey learningRate()
```
    Double parameter used to control the learning rate of an optimizer. Adjustable in progress
  - linkedModelFileName
```
public static MLParameterKey linkedModelFileName()
```
    String parameter used to specify the name of a linked model
  - linkedModelSearchPath
```
public static MLParameterKey linkedModelSearchPath()
```
    String parameteru sed to specify the search path for a linked model
  - miniBatchSize
```
public static MLParameterKey miniBatchSize()
```
    Int64 parameter used to specify the size of a miniBatch used by optimizer. Adjustable at load-time
  - momentum
```
public static MLParameterKey momentum()
```
    Double parameter used to control the momentum of gradient based optimizers. Adjustable at load-time
  - new_objc
```
public static MLParameterKey new_objc()
```
  - numberOfNeighbors
```
public static MLParameterKey numberOfNeighbors()
```
    Int64 parameter used to specify the number of neighbors to use for class affinity (applicable to kNN). Not adjustable in progress
  - resolveClassMethod
```
public static boolean resolveClassMethod(org.moe.natj.objc.SEL sel)
```
  - resolveInstanceMethod
```
public static boolean resolveInstanceMethod(org.moe.natj.objc.SEL sel)
```
  - scopedTo
```
public MLParameterKey scopedTo(java.lang.String scope)
```
    Returns a new MLParameterKey instance after adding additional scoping
  - seed
```
public static MLParameterKey seed()
```
    Int64 parameter used to specify the seed to be used if shuffling data between epochs. Adjustable at load-time
  - setVersion_static
```
public static void setVersion_static(long aVersion)
```
  - shuffle
```
public static MLParameterKey shuffle()
```
    Bool parameter used to specify whether to shuffle the data between epochs. Adjustable at load-time
  - superclass_static
```
public static org.moe.natj.objc.Class superclass_static()
```
  - supportsSecureCoding
```
public static boolean supportsSecureCoding()
```
  - _supportsSecureCoding
```
public boolean _supportsSecureCoding()
```
    Description copied from interface: NSSecureCoding
    
    This property must return YES on all classes that allow secure coding. Subclasses of classes that adopt NSSecureCoding and override initWithCoder: must also override this method and return YES. The Secure Coding Guide should be consulted when writing methods that decode data.
    
    Specified by:
    
    _supportsSecureCoding in interface NSSecureCoding
    
    Overrides:
    
    _supportsSecureCoding in class MLKey
  - version_static
```
public static long version_static()
```
  - weights
```
public static MLParameterKey weights()
```
    MLMultiArray parameter returned when client requests for weights of a particular layer using a scoped parameter.

Class MLParameterKey

Nested Class Summary

Nested classes/interfaces inherited from class apple.NSObject

Constructor Summary

Method Summary

Methods inherited from class apple.coreml.MLKey

Methods inherited from class apple.NSObject

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

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

Methods inherited from class java.lang.Object

Constructor Detail

MLParameterKey

Method Detail

accessInstanceVariablesDirectly

alloc

allocWithZone

automaticallyNotifiesObserversForKey

beta1

beta2

biases

cancelPreviousPerformRequestsWithTarget

cancelPreviousPerformRequestsWithTargetSelectorObject

classFallbacksForKeyedArchiver

classForKeyedUnarchiver

debugDescription_static

description_static

epochs

eps

hash_static

init

initWithCoder

instanceMethodForSelector

instanceMethodSignatureForSelector

instancesRespondToSelector

isSubclassOfClass

keyPathsForValuesAffectingValueForKey

learningRate

linkedModelFileName

linkedModelSearchPath

miniBatchSize

momentum

new_objc

numberOfNeighbors

resolveClassMethod

resolveInstanceMethod

scopedTo

seed

setVersion_static

shuffle

superclass_static

supportsSecureCoding

_supportsSecureCoding

version_static

weights