org.bytedeco.pytorch

Class StreamSampler

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.pytorch.BatchSizeSampler

org.bytedeco.pytorch.StreamSampler

All Implemented Interfaces:

AutoCloseable

@Namespace(value="torch::data::samplers")
 @NoOffset
 @Properties(inherit=torch.class)
public class StreamSampler
extends BatchSizeSampler

A sampler for (potentially infinite) streams of data. The major feature of the StreamSampler is that it does not return particular indices, but instead only the number of elements to fetch from the dataset. The dataset has to decide how to produce those elements.

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
StreamSampler(long epoch_size) Constructs the StreamSampler with the number of individual examples that should be fetched until the sampler is exhausted.
StreamSampler(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
void	load(InputArchive archive) Deserializes the StreamSampler from the archive.
BatchSizeOptional	next(long batch_size) Returns a BatchSize object with the number of elements to fetch in the next batch.
void	reset()
void	reset(SizeTOptional new_size) Resets the internal state of the sampler.
void	save(OutputArchive archive) Serializes the StreamSampler to the archive.

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

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

Constructor Detail

StreamSampler

public StreamSampler(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

StreamSampler

public StreamSampler(@Cast(value="size_t")
                     long epoch_size)

Constructs the StreamSampler with the number of individual examples that should be fetched until the sampler is exhausted.

Method Detail

reset

public void reset(@ByVal(nullValue="c10::optional<size_t>(c10::nullopt)")
                  SizeTOptional new_size)

Resets the internal state of the sampler.

Overrides:

reset in class BatchSizeSampler

reset

public void reset()

next

@ByVal
public BatchSizeOptional next(@Cast(value="size_t")
                                     long batch_size)

Returns a BatchSize object with the number of elements to fetch in the next batch. This number is the minimum of the supplied batch_size and the difference between the epoch_size and the current index. If the epoch_size has been reached, returns an empty optional.

Overrides:

next in class BatchSizeSampler

save

public void save(@ByRef
                 OutputArchive archive)

Serializes the StreamSampler to the archive.

Overrides:

save in class BatchSizeSampler

load

public void load(@ByRef
                 InputArchive archive)

Deserializes the StreamSampler from the archive.

Overrides:

load in class BatchSizeSampler