org.bytedeco.pytorch

Class BCEWithLogitsLossImpl

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.pytorch.Module

org.bytedeco.pytorch.BCEWithLogitsLossImplCloneable

org.bytedeco.pytorch.BCEWithLogitsLossImpl

All Implemented Interfaces:

AutoCloseable

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

This loss combines a Sigmoid layer and the BCELoss in one single class. This version is more numerically stable than using a plain Sigmoid followed by a BCELoss as, by combining the operations into one layer, we take advantage of the log-sum-exp trick for numerical stability. See https://pytorch.org/docs/master/nn.html#torch.nn.BCEWithLogitsLoss to learn about the exact behavior of this module. See the documentation for torch::nn::BCEWithLogitsLossOptions class to learn what constructor arguments are supported for this module. Example:

  BCEWithLogitsLoss
  model(BCEWithLogitsLossOptions().reduction(torch::kNone).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
BCEWithLogitsLossImpl()
BCEWithLogitsLossImpl(BCEWithLogitsLossOptions options_)
BCEWithLogitsLossImpl(Module pointer) Downcast constructor.
BCEWithLogitsLossImpl(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
Tensor	forward(Tensor input, Tensor target)
BCEWithLogitsLossOptions	options() The options with which this Module was constructed.
BCEWithLogitsLossImpl	options(BCEWithLogitsLossOptions setter)
Tensor	pos_weight() A weight of positive examples.
BCEWithLogitsLossImpl	pos_weight(Tensor setter)
void	pretty_print(Pointer stream) Pretty prints the BCEWithLogitsLoss module into the given stream.
void	reset() reset() must perform initialization of all members with reference semantics, most importantly parameters, buffers and submodules.
Tensor	weight() A manual rescaling weight given to the loss of each batch element.
BCEWithLogitsLossImpl	weight(Tensor setter)

Methods inherited from class org.bytedeco.pytorch.BCEWithLogitsLossImplCloneable

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

BCEWithLogitsLossImpl

public BCEWithLogitsLossImpl(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

BCEWithLogitsLossImpl

public BCEWithLogitsLossImpl(Module pointer)

Downcast constructor.

BCEWithLogitsLossImpl

public BCEWithLogitsLossImpl(@ByVal(nullValue="torch::nn::BCEWithLogitsLossOptions{}")
                             BCEWithLogitsLossOptions options_)

BCEWithLogitsLossImpl

public BCEWithLogitsLossImpl()

Method Detail

reset

public void reset()

Description copied from class: BCEWithLogitsLossImplCloneable

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

Overrides:

reset in class BCEWithLogitsLossImplCloneable

pretty_print

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

Pretty prints the BCEWithLogitsLoss 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 BCEWithLogitsLossOptions options()

The options with which this Module was constructed.

options

public BCEWithLogitsLossImpl options(BCEWithLogitsLossOptions setter)

weight

@ByRef
public Tensor weight()

A manual rescaling weight given to the loss of each batch element.

weight

public BCEWithLogitsLossImpl weight(Tensor setter)

pos_weight

@ByRef
public Tensor pos_weight()

A weight of positive examples.

pos_weight

public BCEWithLogitsLossImpl pos_weight(Tensor setter)