org.bytedeco.pytorch

Class TripletMarginWithDistanceLossImpl

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.pytorch.Module

org.bytedeco.pytorch.TripletMarginWithDistanceLossImplCloneable

org.bytedeco.pytorch.TripletMarginWithDistanceLossImpl

All Implemented Interfaces:

AutoCloseable

@Namespace(value="torch::nn")
 @NoOffset
 @Properties(inherit=torch.class)
public class TripletMarginWithDistanceLossImpl
extends TripletMarginWithDistanceLossImplCloneable

Creates a criterion that measures the triplet loss given input tensors :math:a, :math:p, and :math:n (representing anchor, positive, and negative examples, respectively); and a nonnegative, real-valued function ("distance function") used to compute the relationships between the anchor and positive example ("positive distance") and the anchor and negative example ("negative distance"). See https://pytorch.org/docs/master/nn.html#torch.nn.TripletMarginWithDistanceLoss to learn about the exact behavior of this module. See the documentation for torch::nn::TripletMarginWithDistanceLossOptions class to learn what constructor arguments are supported for this module. Example:

  TripletMarginWithDistanceLoss
  model(TripletMarginWithDistanceLossOptions().margin(3).swap(false));
  

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
TripletMarginWithDistanceLossImpl()
TripletMarginWithDistanceLossImpl(Module pointer) Downcast constructor.
TripletMarginWithDistanceLossImpl(Pointer p) Pointer cast constructor.
TripletMarginWithDistanceLossImpl(TripletMarginWithDistanceLossOptions options_)

Method Summary

Modifier and Type	Method and Description
Tensor	forward(Tensor anchor, Tensor positive, Tensor negative)
TripletMarginWithDistanceLossOptions	options() The options with which this Module was constructed.
TripletMarginWithDistanceLossImpl	options(TripletMarginWithDistanceLossOptions setter)
void	pretty_print(Pointer stream) Pretty prints the TripletMarginWithDistanceLoss module into the given stream.
void	reset() reset() must perform initialization of all members with reference semantics, most importantly parameters, buffers and submodules.

Methods inherited from class org.bytedeco.pytorch.TripletMarginWithDistanceLossImplCloneable

asModule, asModule, clone, clone

Methods inherited from class org.bytedeco.pytorch.Module

apply, apply, apply, apply, apply, apply, apply, apply, buffers, buffers, children, eval, is_serializable, is_training, load, modules, modules, name, named_buffers, named_buffers, named_children, named_modules, named_modules, named_modules, named_parameters, named_parameters, parameters, parameters, register_buffer, register_buffer, register_module, register_module, register_parameter, register_parameter, register_parameter, register_parameter, save, shiftLeft, to, to, to, train, unregister_module, unregister_module, zero_grad

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, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, position, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

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

Constructor Detail

TripletMarginWithDistanceLossImpl

public TripletMarginWithDistanceLossImpl(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

TripletMarginWithDistanceLossImpl

public TripletMarginWithDistanceLossImpl(Module pointer)

Downcast constructor.

TripletMarginWithDistanceLossImpl

public TripletMarginWithDistanceLossImpl(@ByVal(nullValue="torch::nn::TripletMarginWithDistanceLossOptions{}")
                                         TripletMarginWithDistanceLossOptions options_)

TripletMarginWithDistanceLossImpl

public TripletMarginWithDistanceLossImpl()

Method Detail

reset

public void reset()

Description copied from class: TripletMarginWithDistanceLossImplCloneable

reset() must perform initialization of all members with reference semantics, most importantly parameters, buffers and submodules.

Overrides:

reset in class TripletMarginWithDistanceLossImplCloneable

pretty_print

public void pretty_print(@Cast(value="std::ostream*") @ByRef
                         Pointer stream)

Pretty prints the TripletMarginWithDistanceLoss module into the given stream.

Overrides:

pretty_print in class Module

forward

@ByVal
public Tensor forward(@Const @ByRef
                             Tensor anchor,
                             @Const @ByRef
                             Tensor positive,
                             @Const @ByRef
                             Tensor negative)

options

@ByRef
public TripletMarginWithDistanceLossOptions options()

The options with which this Module was constructed.

options

public TripletMarginWithDistanceLossImpl options(TripletMarginWithDistanceLossOptions setter)