org.bytedeco.pytorch

Class OptimizerCloneableAdagradOptions

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.pytorch.OptimizerOptions

org.bytedeco.pytorch.OptimizerCloneableAdagradOptions

All Implemented Interfaces:

AutoCloseable

Direct Known Subclasses:

AdagradOptions

@Name(value="torch::optim::OptimizerCloneableOptions<torch::optim::AdagradOptions>")
 @Properties(inherit=torch.class)
public class OptimizerCloneableAdagradOptions
extends OptimizerOptions

OptimizerCloneableOptions provides parameter group inheritance functionality for PyTorch C++ optimizer options. When creating parameter groups with partial options (e.g., AdamOptions().weight_decay(0.1)), fields not explicitly set by the user inherit from the optimizer's default values, while explicitly set fields are preserved. This enables Python-like behavior in C++:

 cpp
 // Python equivalent:
 // optimizer = Adam([{'params': params1, 'weight_decay': 0.1}], lr=0.01)
 // Result: weight_decay=0.1 preserved, lr=0.01 inherited

 AdamOptions defaults;
 defaults.lr(0.01).weight_decay(0.05);

 std::vector<OptimizerParamGroup> groups;
 groups.emplace_back(params1, std::make_unique<AdamOptions>(
     AdamOptions().weight_decay(0.1)));  // Only weight_decay specified

 Adam optimizer(groups, defaults);
 // Result: group inherits lr=0.01, preserves weight_decay=0.1
 

**Implementation**: Uses SFINAE-based field detection and constructor-default comparison to distinguish explicitly set fields from default values. Fields that match constructor defaults are inherited; others are preserved.

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
OptimizerCloneableAdagradOptions() Default native constructor.
OptimizerCloneableAdagradOptions(long size) Native array allocator.
OptimizerCloneableAdagradOptions(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
OptimizerCloneableAdagradOptions	getPointer(long i)
OptimizerCloneableAdagradOptions	position(long position)

Methods inherited from class org.bytedeco.pytorch.OptimizerOptions

clone, get_lr, put, set_lr

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getDirectBufferAddress, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, trimMemory, withDeallocator, zero

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

OptimizerCloneableAdagradOptions

public OptimizerCloneableAdagradOptions()

Default native constructor.

OptimizerCloneableAdagradOptions

public OptimizerCloneableAdagradOptions(long size)

Native array allocator. Access with Pointer.position(long).

OptimizerCloneableAdagradOptions

public OptimizerCloneableAdagradOptions(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

position

public OptimizerCloneableAdagradOptions position(long position)

Overrides:

position in class Pointer

getPointer

public OptimizerCloneableAdagradOptions getPointer(long i)

Overrides:

getPointer in class Pointer