org.bytedeco.pytorch

Class InputArchive

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.pytorch.InputArchive

All Implemented Interfaces:

AutoCloseable

@Namespace(value="torch::serialize")
 @NoOffset
 @Properties(inherit=torch.class)
public class InputArchive
extends Pointer

A recursive representation of tensors that can be deserialized from a file or stream. In most cases, users should not have to interact with this class, and should instead use torch::load.

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
InputArchive() Default-constructs the InputArchive.
InputArchive(InputArchive arg0)
InputArchive(long size) Native array allocator.
InputArchive(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
InputArchive	getPointer(long i)
StringVector	keys()
void	load_from(BytePointer filename)
void	load_from(BytePointer filename, DeviceOptional device) Loads the InputArchive from a serialized representation stored in the file at filename.
void	load_from(BytePointer data, long size)
void	load_from(BytePointer data, long size, DeviceOptional device)
void	load_from(Pointer stream)
void	load_from(Pointer stream, DeviceOptional device) Loads the InputArchive from a serialized representation stored in the given stream.
void	load_from(Reader read_func, SizeTSupplier size_func)
void	load_from(Reader read_func, SizeTSupplier size_func, DeviceOptional device)
void	load_from(String filename)
void	load_from(String filename, DeviceOptional device)
void	load_from(String data, long size)
void	load_from(String data, long size, DeviceOptional device)
InputArchive	position(long position)
void	read(BytePointer key, InputArchive archive) Reads an InputArchive associated with a given key.
void	read(BytePointer key, IValue ivalue) Reads an IValue associated with a given key.
void	read(BytePointer key, Tensor tensor)
void	read(BytePointer key, Tensor tensor, boolean is_buffer) Reads a tensor associated with a given key.
void	read(String key, InputArchive archive)
void	read(String key, IValue ivalue)
void	read(String key, Tensor tensor)
void	read(String key, Tensor tensor, boolean is_buffer)
boolean	try_read(BytePointer key, InputArchive archive) Reads a InputArchive associated with a given key.
boolean	try_read(BytePointer key, IValue ivalue) Reads an IValue associated with a given key.
boolean	try_read(BytePointer key, Tensor tensor)
boolean	try_read(BytePointer key, Tensor tensor, boolean is_buffer) Reads a tensor associated with a given key.
boolean	try_read(String key, InputArchive archive)
boolean	try_read(String key, IValue ivalue)
boolean	try_read(String key, Tensor tensor)
boolean	try_read(String key, Tensor tensor, boolean is_buffer)

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, withDeallocator, zero

Methods inherited from class java.lang.Object

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

Constructor Detail

InputArchive

public InputArchive(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

InputArchive

public InputArchive(long size)

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

InputArchive

public InputArchive()

Default-constructs the InputArchive.

InputArchive

public InputArchive(@ByRef(value=true)
                    InputArchive arg0)

Method Detail

position

public InputArchive position(long position)

Overrides:

position in class Pointer

getPointer

public InputArchive getPointer(long i)

Overrides:

getPointer in class Pointer

read

public void read(@StdString
                 BytePointer key,
                 @ByRef
                 IValue ivalue)

Reads an IValue associated with a given key.

read

public void read(@StdString
                 String key,
                 @ByRef
                 IValue ivalue)

try_read

@Cast(value="bool")
public boolean try_read(@StdString
                                            BytePointer key,
                                            @ByRef
                                            IValue ivalue)

Reads an IValue associated with a given key. If there is no IValue associated with the key, this returns false, otherwise it returns true.

try_read

@Cast(value="bool")
public boolean try_read(@StdString
                                            String key,
                                            @ByRef
                                            IValue ivalue)

try_read

@Cast(value="bool")
public boolean try_read(@StdString
                                            BytePointer key,
                                            @ByRef
                                            Tensor tensor,
                                            @Cast(value="bool")
                                            boolean is_buffer)

Reads a tensor associated with a given key. If there is no tensor associated with the key, this returns false, otherwise it returns true. If the tensor is expected to be a buffer (not differentiable), is_buffer must be true.

try_read

@Cast(value="bool")
public boolean try_read(@StdString
                                            BytePointer key,
                                            @ByRef
                                            Tensor tensor)

try_read

@Cast(value="bool")
public boolean try_read(@StdString
                                            String key,
                                            @ByRef
                                            Tensor tensor,
                                            @Cast(value="bool")
                                            boolean is_buffer)

try_read

@Cast(value="bool")
public boolean try_read(@StdString
                                            String key,
                                            @ByRef
                                            Tensor tensor)

read

public void read(@StdString
                 BytePointer key,
                 @ByRef
                 Tensor tensor,
                 @Cast(value="bool")
                 boolean is_buffer)

Reads a tensor associated with a given key. If the tensor is expected to be a buffer (not differentiable), is_buffer must be true.

read

public void read(@StdString
                 BytePointer key,
                 @ByRef
                 Tensor tensor)

read

public void read(@StdString
                 String key,
                 @ByRef
                 Tensor tensor,
                 @Cast(value="bool")
                 boolean is_buffer)

read

public void read(@StdString
                 String key,
                 @ByRef
                 Tensor tensor)

try_read

@Cast(value="bool")
public boolean try_read(@StdString
                                            BytePointer key,
                                            @ByRef
                                            InputArchive archive)

Reads a InputArchive associated with a given key. If there is no InputArchive associated with the key, this returns false, otherwise it returns true.

try_read

@Cast(value="bool")
public boolean try_read(@StdString
                                            String key,
                                            @ByRef
                                            InputArchive archive)

read

public void read(@StdString
                 BytePointer key,
                 @ByRef
                 InputArchive archive)

Reads an InputArchive associated with a given key. The archive can thereafter be used for further deserialization of the nested data.

read

public void read(@StdString
                 String key,
                 @ByRef
                 InputArchive archive)

load_from

public void load_from(@StdString
                      BytePointer filename,
                      @ByVal(nullValue="c10::optional<torch::Device>(c10::nullopt)")
                      DeviceOptional device)

Loads the InputArchive from a serialized representation stored in the file at filename. Storage are remapped using device option. If device is not specified, the module is loaded to the original device.

load_from

public void load_from(@StdString
                      BytePointer filename)

load_from

public void load_from(@StdString
                      String filename,
                      @ByVal(nullValue="c10::optional<torch::Device>(c10::nullopt)")
                      DeviceOptional device)

load_from

public void load_from(@StdString
                      String filename)

load_from

public void load_from(@Cast(value="std::istream*") @ByRef
                      Pointer stream,
                      @ByVal(nullValue="c10::optional<torch::Device>(c10::nullopt)")
                      DeviceOptional device)

Loads the InputArchive from a serialized representation stored in the given stream. Storage are remapped using device option. If device is not specified, the module is loaded to the original device.

load_from

public void load_from(@Cast(value="std::istream*") @ByRef
                      Pointer stream)

load_from

public void load_from(@Cast(value="const char*")
                      BytePointer data,
                      @Cast(value="size_t")
                      long size,
                      @ByVal(nullValue="c10::optional<torch::Device>(c10::nullopt)")
                      DeviceOptional device)

load_from

public void load_from(@Cast(value="const char*")
                      BytePointer data,
                      @Cast(value="size_t")
                      long size)

load_from

public void load_from(String data,
                      @Cast(value="size_t")
                      long size,
                      @ByVal(nullValue="c10::optional<torch::Device>(c10::nullopt)")
                      DeviceOptional device)

load_from

public void load_from(String data,
                      @Cast(value="size_t")
                      long size)

load_from

public void load_from(@Const @ByRef
                      Reader read_func,
                      @Const @ByRef
                      SizeTSupplier size_func,
                      @ByVal(nullValue="c10::optional<torch::Device>(c10::nullopt)")
                      DeviceOptional device)

load_from

public void load_from(@Const @ByRef
                      Reader read_func,
                      @Const @ByRef
                      SizeTSupplier size_func)

keys

@ByVal
public StringVector keys()