#[repr(C)]pub struct MLCSGDOptimizer { /* private fields */ }
MLCOptimizer
and MLCSGDOptimizer
only.Expand description
The MLCSGDOptimizer specifies a stochastic gradient descent optimizer.
See also Appleโs documentation
Implementationsยง
Sourceยงimpl MLCSGDOptimizer
impl MLCSGDOptimizer
Sourcepub unsafe fn momentumScale(&self) -> c_float
๐Deprecated
pub unsafe fn momentumScale(&self) -> c_float
The momentum factor. A hyper-parameter.
The default is 0.0.
Sourcepub unsafe fn usesNesterovMomentum(&self) -> bool
๐Deprecated
pub unsafe fn usesNesterovMomentum(&self) -> bool
A boolean that specifies whether to apply nesterov momentum or not.
The default is false.
Sourcepub unsafe fn optimizerWithDescriptor(
optimizer_descriptor: &MLCOptimizerDescriptor,
) -> Retained<Self>
๐DeprecatedAvailable on crate feature MLCOptimizerDescriptor
only.
pub unsafe fn optimizerWithDescriptor( optimizer_descriptor: &MLCOptimizerDescriptor, ) -> Retained<Self>
MLCOptimizerDescriptor
only.Create an MLCSGDOptimizer object with defaults
Returns: A new MLCSGDOptimizer object.
Sourcepub unsafe fn optimizerWithDescriptor_momentumScale_usesNesterovMomentum(
optimizer_descriptor: &MLCOptimizerDescriptor,
momentum_scale: c_float,
uses_nesterov_momentum: bool,
) -> Retained<Self>
๐DeprecatedAvailable on crate feature MLCOptimizerDescriptor
only.
pub unsafe fn optimizerWithDescriptor_momentumScale_usesNesterovMomentum( optimizer_descriptor: &MLCOptimizerDescriptor, momentum_scale: c_float, uses_nesterov_momentum: bool, ) -> Retained<Self>
MLCOptimizerDescriptor
only.Create an MLCSGDOptimizer object
Parameter optimizerDescriptor
: The optimizer descriptor object
Parameter momentumScale
: The momentum scale
Parameter usesNesterovMomentum
: A boolean to enable / disable nesterov momentum
Returns: A new MLCSGDOptimizer object.
Methods from Deref<Target = MLCOptimizer>ยง
Sourcepub unsafe fn learningRate(&self) -> c_float
๐Deprecated
pub unsafe fn learningRate(&self) -> c_float
The learning rate. This property is โreadwriteโ so that callers can implement a โdecayโ during training
Sourcepub unsafe fn setLearningRate(&self, learning_rate: c_float)
๐Deprecated
pub unsafe fn setLearningRate(&self, learning_rate: c_float)
Setter for learningRate
.
Sourcepub unsafe fn gradientRescale(&self) -> c_float
๐Deprecated
pub unsafe fn gradientRescale(&self) -> c_float
The rescale value applied to gradients during optimizer update
Sourcepub unsafe fn appliesGradientClipping(&self) -> bool
๐Deprecated
pub unsafe fn appliesGradientClipping(&self) -> bool
Whether gradient clipping should be applied or not.
Sourcepub unsafe fn setAppliesGradientClipping(&self, applies_gradient_clipping: bool)
๐Deprecated
pub unsafe fn setAppliesGradientClipping(&self, applies_gradient_clipping: bool)
Setter for appliesGradientClipping
.
Sourcepub unsafe fn gradientClipMax(&self) -> c_float
๐Deprecated
pub unsafe fn gradientClipMax(&self) -> c_float
The maximum gradient value if gradient clipping is enabled before gradient is rescaled.
Sourcepub unsafe fn gradientClipMin(&self) -> c_float
๐Deprecated
pub unsafe fn gradientClipMin(&self) -> c_float
The minimum gradient value if gradient clipping is enabled before gradient is rescaled.
Sourcepub unsafe fn regularizationScale(&self) -> c_float
๐Deprecated
pub unsafe fn regularizationScale(&self) -> c_float
The regularization scale.
Sourcepub unsafe fn regularizationType(&self) -> MLCRegularizationType
๐DeprecatedAvailable on crate feature MLCTypes
only.
pub unsafe fn regularizationType(&self) -> MLCRegularizationType
MLCTypes
only.The regularization type.
Sourcepub unsafe fn gradientClippingType(&self) -> MLCGradientClippingType
Available on crate feature MLCTypes
only.
pub unsafe fn gradientClippingType(&self) -> MLCGradientClippingType
MLCTypes
only.The type of clipping applied to gradient
Sourcepub unsafe fn maximumClippingNorm(&self) -> c_float
pub unsafe fn maximumClippingNorm(&self) -> c_float
The maximum clipping value
Sourcepub unsafe fn customGlobalNorm(&self) -> c_float
pub unsafe fn customGlobalNorm(&self) -> c_float
Used only with MLCGradientClippingTypeByGlobalNorm. If non zero, this norm will be used in place of global norm.
Methods from Deref<Target = NSObject>ยง
Sourcepub fn doesNotRecognizeSelector(&self, sel: Sel) -> !
pub fn doesNotRecognizeSelector(&self, sel: Sel) -> !
Handle messages the object doesnโt recognize.
See Appleโs documentation for details.
Methods from Deref<Target = AnyObject>ยง
Sourcepub fn class(&self) -> &'static AnyClass
pub fn class(&self) -> &'static AnyClass
Dynamically find the class of this object.
ยงPanics
May panic if the object is invalid (which may be the case for objects
returned from unavailable init
/new
methods).
ยงExample
Check that an instance of NSObject
has the precise class NSObject
.
use objc2::ClassType;
use objc2::runtime::NSObject;
let obj = NSObject::new();
assert_eq!(obj.class(), NSObject::class());
Sourcepub unsafe fn get_ivar<T>(&self, name: &str) -> &Twhere
T: Encode,
๐Deprecated: this is difficult to use correctly, use Ivar::load
instead.
pub unsafe fn get_ivar<T>(&self, name: &str) -> &Twhere
T: Encode,
Ivar::load
instead.Use Ivar::load
instead.
ยงSafety
The object must have an instance variable with the given name, and it
must be of type T
.
See Ivar::load_ptr
for details surrounding this.
Sourcepub fn downcast_ref<T>(&self) -> Option<&T>where
T: DowncastTarget,
pub fn downcast_ref<T>(&self) -> Option<&T>where
T: DowncastTarget,
Attempt to downcast the object to a class of type T
.
This is the reference-variant. Use Retained::downcast
if you want
to convert a retained object to another type.
ยงMutable classes
Some classes have immutable and mutable variants, such as NSString
and NSMutableString
.
When some Objective-C API signature says it gives you an immutable class, it generally expects you to not mutate that, even though it may technically be mutable โunder the hoodโ.
So using this method to convert a NSString
to a NSMutableString
,
while not unsound, is generally frowned upon unless you created the
string yourself, or the API explicitly documents the string to be
mutable.
See Appleโs documentation on mutability and on
isKindOfClass:
for more details.
ยงGeneric classes
Objective-C generics are called โlightweight genericsโ, and thatโs because they arenโt exposed in the runtime. This makes it impossible to safely downcast to generic collections, so this is disallowed by this method.
You can, however, safely downcast to generic collections where all the
type-parameters are AnyObject
.
ยงPanics
This works internally by calling isKindOfClass:
. That means that the
object must have the instance method of that name, and an exception
will be thrown (if CoreFoundation is linked) or the process will abort
if that is not the case. In the vast majority of cases, you donโt need
to worry about this, since both root objects NSObject
and
NSProxy
implement this method.
ยงExamples
Cast an NSString
back and forth from NSObject
.
use objc2::rc::Retained;
use objc2_foundation::{NSObject, NSString};
let obj: Retained<NSObject> = NSString::new().into_super();
let string = obj.downcast_ref::<NSString>().unwrap();
// Or with `downcast`, if we do not need the object afterwards
let string = obj.downcast::<NSString>().unwrap();
Try (and fail) to cast an NSObject
to an NSString
.
use objc2_foundation::{NSObject, NSString};
let obj = NSObject::new();
assert!(obj.downcast_ref::<NSString>().is_none());
Try to cast to an array of strings.
use objc2_foundation::{NSArray, NSObject, NSString};
let arr = NSArray::from_retained_slice(&[NSObject::new()]);
// This is invalid and doesn't type check.
let arr = arr.downcast_ref::<NSArray<NSString>>();
This fails to compile, since it would require enumerating over the array to ensure that each element is of the desired type, which is a performance pitfall.
Downcast when processing each element instead.
use objc2_foundation::{NSArray, NSObject, NSString};
let arr = NSArray::from_retained_slice(&[NSObject::new()]);
for elem in arr {
if let Some(data) = elem.downcast_ref::<NSString>() {
// handle `data`
}
}
Trait Implementationsยง
Sourceยงimpl AsRef<AnyObject> for MLCSGDOptimizer
impl AsRef<AnyObject> for MLCSGDOptimizer
Sourceยงimpl AsRef<MLCOptimizer> for MLCSGDOptimizer
impl AsRef<MLCOptimizer> for MLCSGDOptimizer
Sourceยงfn as_ref(&self) -> &MLCOptimizer
fn as_ref(&self) -> &MLCOptimizer
Sourceยงimpl AsRef<MLCSGDOptimizer> for MLCSGDOptimizer
impl AsRef<MLCSGDOptimizer> for MLCSGDOptimizer
Sourceยงimpl AsRef<NSObject> for MLCSGDOptimizer
impl AsRef<NSObject> for MLCSGDOptimizer
Sourceยงimpl Borrow<AnyObject> for MLCSGDOptimizer
impl Borrow<AnyObject> for MLCSGDOptimizer
Sourceยงimpl Borrow<MLCOptimizer> for MLCSGDOptimizer
impl Borrow<MLCOptimizer> for MLCSGDOptimizer
Sourceยงfn borrow(&self) -> &MLCOptimizer
fn borrow(&self) -> &MLCOptimizer
Sourceยงimpl Borrow<NSObject> for MLCSGDOptimizer
impl Borrow<NSObject> for MLCSGDOptimizer
Sourceยงimpl ClassType for MLCSGDOptimizer
impl ClassType for MLCSGDOptimizer
Sourceยงconst NAME: &'static str = "MLCSGDOptimizer"
const NAME: &'static str = "MLCSGDOptimizer"
Sourceยงtype Super = MLCOptimizer
type Super = MLCOptimizer
Sourceยงtype ThreadKind = <<MLCSGDOptimizer as ClassType>::Super as ClassType>::ThreadKind
type ThreadKind = <<MLCSGDOptimizer as ClassType>::Super as ClassType>::ThreadKind
Sourceยงimpl CopyingHelper for MLCSGDOptimizer
impl CopyingHelper for MLCSGDOptimizer
Sourceยงtype Result = MLCSGDOptimizer
type Result = MLCSGDOptimizer
Self
if the type has no
immutable counterpart. Read moreSourceยงimpl Debug for MLCSGDOptimizer
impl Debug for MLCSGDOptimizer
Sourceยงimpl Deref for MLCSGDOptimizer
impl Deref for MLCSGDOptimizer
Sourceยงimpl Hash for MLCSGDOptimizer
impl Hash for MLCSGDOptimizer
Sourceยงimpl Message for MLCSGDOptimizer
impl Message for MLCSGDOptimizer
Sourceยงimpl NSCopying for MLCSGDOptimizer
impl NSCopying for MLCSGDOptimizer
Sourceยงimpl NSObjectProtocol for MLCSGDOptimizer
impl NSObjectProtocol for MLCSGDOptimizer
Sourceยงfn isEqual(&self, other: Option<&AnyObject>) -> bool
fn isEqual(&self, other: Option<&AnyObject>) -> bool
Sourceยงfn hash(&self) -> usize
fn hash(&self) -> usize
Sourceยงfn isKindOfClass(&self, cls: &AnyClass) -> bool
fn isKindOfClass(&self, cls: &AnyClass) -> bool
Sourceยงfn is_kind_of<T>(&self) -> bool
fn is_kind_of<T>(&self) -> bool
isKindOfClass
directly, or cast your objects with AnyObject::downcast_ref