org.bytedeco.pytorch

Class MultiMarginLossImpl

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.pytorch.Module

org.bytedeco.pytorch.MultiMarginLossImplCloneable

org.bytedeco.pytorch.MultiMarginLossImpl

All Implemented Interfaces:

AutoCloseable

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

Creates a criterion that optimizes a multi-class classification hinge loss (margin-based loss) between input :math:x (a 2D mini-batch Tensor) and output :math:y (which is a 1D tensor of target class indices, :math:0 \leq y \leq \text{x.size}(1)-1). See https://pytorch.org/docs/master/nn.html#torch.nn.MultiMarginLoss to learn about the exact behavior of this module. See the documentation for torch::nn::MultiMarginLossOptions class to learn what constructor arguments are supported for this module. Example:

  MultiMarginLoss model(MultiMarginLossOptions().margin(2).weight(weight));
  

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

Method Summary

Modifier and Type	Method and Description
Tensor	forward(Tensor input, Tensor target)
MultiMarginLossOptions	options() The options with which this Module was constructed.
MultiMarginLossImpl	options(MultiMarginLossOptions setter)
void	pretty_print(Pointer stream) Pretty prints the MultiMarginLoss 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.MultiMarginLossImplCloneable

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

MultiMarginLossImpl

public MultiMarginLossImpl(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

MultiMarginLossImpl

public MultiMarginLossImpl(Module pointer)

Downcast constructor.

MultiMarginLossImpl

public MultiMarginLossImpl(@ByVal(nullValue="torch::nn::MultiMarginLossOptions{}")
                           MultiMarginLossOptions options_)

MultiMarginLossImpl

public MultiMarginLossImpl()

Method Detail

reset

public void reset()

Description copied from class: MultiMarginLossImplCloneable

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

Overrides:

reset in class MultiMarginLossImplCloneable

pretty_print

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

Pretty prints the MultiMarginLoss module into the given stream.

Overrides:

pretty_print in class Module

forward

@ByVal
public Tensor forward(@Const @ByRef
                             Tensor input,
                             @Const @ByRef
                             Tensor target)

options

@ByRef
public MultiMarginLossOptions options()

The options with which this Module was constructed.

options

public MultiMarginLossImpl options(MultiMarginLossOptions setter)