database_client_interface module reference¶

Data Types¶

`dataset_type`	Dummy type for dataset.
`dbclient_type`	Stores all data and methods associated with the communication client that is used to communicate with the database.

Functions/Subroutines¶

`sr_error_parser()`	Decode a response code from an API function.
`initialize_client()`	Initializes a new instance of a communication client.
`isinitialized()`	Check whether the client has been initialized.
`destructor()`	A destructor for the communication client.
`put_tensor_float_1d()`	Put a 32-bit real 1d tensor into the database.
`put_tensor_float_2d()`	Put a 32-bit real 2d tensor into the database.
`put_tensor_float_3d()`	Put a 32-bit real 3d tensor into the database.
`put_tensor_float_4d()`	Put a 32-bit real 4d tensor into the database.
`put_tensor_double_1d()`	Put a 64-bit real 1d tensor into the database.
`put_tensor_double_2d()`	Put a 64-bit real 2d tensor into the database.
`put_tensor_double_3d()`	Put a 64-bit real 3d tensor into the database.
`put_tensor_double_4d()`	Put a 64-bit real 4d tensor into the database.
`put_tensor_int32_1d()`	Put a 32-bit integer 1d tensor into the database.
`put_tensor_int32_2d()`	Put a 32-bit integer 2d tensor into the database.
`put_tensor_int32_3d()`	Put a 32-bit integer 3d tensor into the database.
`put_tensor_int32_4d()`	Put a 32-bit integer 4d tensor into the database.
`unpack_tensor_float_1d()`	Unpack a 32-bit real 1d tensor from the database.
`unpack_tensor_float_2d()`	Unpack a 32-bit real 2d tensor from the database.
`unpack_tensor_float_3d()`	Unpack a 32-bit real 3d tensor from the database.
`unpack_tensor_float_4d()`	Unpack a 32-bit real 4d tensor from the database.
`unpack_tensor_double_1d()`	Unpack a 64-bit real 1d tensor from the database.
`unpack_tensor_double_2d()`	Unpack a 64-bit real 2d tensor from the database.
`unpack_tensor_double_3d()`	Unpack a 64-bit real 3d tensor from the database.
`unpack_tensor_double_4d()`	Unpack a 64-bit real 4d tensor from the database.
`unpack_tensor_int32_1d()`	Unpack a 32-bit integer 1d tensor from the database.
`unpack_tensor_int32_2d()`	Unpack a 32-bit integer 2d tensor from the database.
`unpack_tensor_int32_3d()`	Unpack a 32-bit integer 3d tensor from the database.
`unpack_tensor_int32_4d()`	Unpack a 32-bit integer 4d tensor from the database.
`rename_tensor()`	Move a tensor to a new name.
`delete_tensor()`	Delete a tensor.
`copy_tensor()`	Copy a tensor to the destination name.
`get_model()`	Retrieve the model from the database.
`set_model_from_file()`	Load the machine learning model from a file and set the configuration.
`set_model_from_file_multigpu()`	Load the machine learning model from a file and set the configuration for use in multi-GPU systems.
`set_model()`	Establish a model to run.
`set_model_multigpu()`	Set a model from a byte string to run on a system with multiple GPUs.
`run_model()`	Run a model in the database using the specified input and output tensors.
`run_model_multigpu()`	Run a model in the database using the specified input and output tensors in a multi-GPU system.
`delete_model()`	Remove a model from the database.
`delete_model_multigpu()`	Remove a model from the database.
`get_script()`	Retrieve the script from the database.
`set_script_from_file()`	Set a script (from file) in the database for future execution.
`set_script_from_file_multigpu()`	Set a script (from file) in the database for future execution in a multi-GPU system.
`set_script()`	Set a script (from buffer) in the database for future execution.
`set_script_multigpu()`	Set a script (from buffer) in the database for future execution in a multi-GPU system.
`run_script()`
`run_script_multigpu()`
`delete_script()`	Remove a script from the database.
`delete_script_multigpu()`	Remove a script_multigpu from the database.
`put_dataset()`	Store a dataset in the database.
`get_dataset()`	Retrieve a dataset from the database.
`rename_dataset()`	Rename a dataset stored in the database.
`copy_dataset()`	Copy a dataset within the database to a new name.
`delete_dataset()`	Delete a dataset stored within a database.
`append_to_list()`	Appends a dataset to the aggregation list When appending a dataset to an aggregation list, the list will automatically be created if it does not exist (i.e.
`delete_list()`	Delete an aggregation list.
`copy_list()`	Copy an aggregation list.
`rename_list()`	Rename an aggregation list.

Detailed Description¶

Type Documentation¶

type database_client_interface/dataset_type¶: Dummy type for dataset.

type database_client_interface/dbclient_type¶

Stores all data and methods associated with the communication client that is used to communicate with the database.

Type fields:

% put_tensor [generic] :: Puts a tensor into the database for a variety of datatypes.
% unpack_tensor [generic] :: Retrieve the tensor in the database into already allocated memory for a variety of datatypesm.
% sr_error_parser [procedure] :: Decode a response code from an API function.
% initialize [procedure] :: Initializes a new instance of the communication client.
% isinitialized [procedure] :: Check if a communication client has been initialized.
% destructor [procedure] :: Destructs a new instance of the communication client.
% rename_tensor [procedure] :: Rename a tensor within the database.
% delete_tensor [procedure] :: Delete a tensor from the database.
% copy_tensor [procedure] :: Copy a tensor within the database to a new name.
% set_model_from_file [procedure] :: Set a model from a file.
% set_model_from_file_multigpu [procedure] :: Set a model from a file on a system with multiple GPUs.
% set_model [procedure] :: Set a model from a byte string that has been loaded within the application.
% set_model_multigpu [procedure] :: Set a model from a byte string that has been loaded within the application on a system with multiple GPUs.
% get_model [procedure] :: Retrieve the model as a byte string.
% set_script_from_file [procedure] :: Set a script from a specified file.
% set_script_from_file_multigpu [procedure] :: Set a script from a specified file on a system with multiple GPUS.
% set_script [procedure] :: Set a script as a byte or text string.
% set_script_multigpu [procedure] :: Set a script as a byte or text string on a system with multiple GPUs.
% get_script [procedure] :: Retrieve the script from the database.
% run_script [procedure] :: Run a script that has already been stored in the database.
% run_script_multigpu [procedure] :: Run a script that has already been stored in the database with multiple GPUs.
% run_model [procedure] :: Run a model that has already been stored in the database.
% run_model_multigpu [procedure] :: Run a model that has already been stored in the database with multiple GPUs.
% delete_script [procedure] :: Remove a script from the database.
% delete_script_multigpu [procedure] :: Remove a script from the database with multiple GPUs.
% delete_model [procedure] :: Remove a model from the database.
% delete_model_multigpu [procedure] :: Remove a model from the database with multiple GPUs.
% put_dataset [procedure] :: Put a communication dataset into the database.
% get_dataset [procedure] :: Retrieve a communication dataset from the database.
% rename_dataset [procedure] :: Rename the dataset within the database.
% copy_dataset [procedure] :: Copy a dataset stored in the database into another name.
% delete_dataset [procedure] :: Delete the dataset from the database.
% put_tensor_float_1d [procedure,private, private] :: Put a 1d, 32-bit real tensor into database.
% put_tensor_float_2d [procedure,private, private] :: Put a 2d, 32-bit real tensor into database.
% put_tensor_float_3d [procedure,private, private] :: Put a 3d, 32-bit real tensor into database.
% put_tensor_float_4d [procedure,private, private] :: Put a 4d, 32-bit real tensor into database.
% put_tensor_double_1d [procedure,private, private] :: Put a 1d, 64-bit real tensor into database.
% put_tensor_double_2d [procedure,private, private] :: Put a 2d, 64-bit real tensor into database.
% put_tensor_double_3d [procedure,private, private] :: Put a 3d, 64-bit real tensor into database.
% put_tensor_double_4d [procedure,private, private] :: Put a 4d, 64-bit real tensor into database.
% put_tensor_int32_1d [procedure,private, private] :: Put a 1d, 32-bit integer tensor into database.
% put_tensor_int32_2d [procedure,private, private] :: Put a 2d, 32-bit integer tensor into database.
% put_tensor_int32_3d [procedure,private, private] :: Put a 3d, 32-bit integer tensor into database.
% put_tensor_int32_4d [procedure,private, private] :: Put a 4d, 32-bit integer tensor into database.
% unpack_tensor_float_1d [procedure,private, private] :: Unpack a 1d, 32-bit real tensor from the database.
% unpack_tensor_float_2d [procedure,private, private] :: Unpack a 2d, 32-bit real tensor from the database.
% unpack_tensor_float_3d [procedure,private, private] :: Unpack a 3d, 32-bit real tensor from the database.
% unpack_tensor_float_4d [procedure,private, private] :: Unpack a 4d, 32-bit real tensor from the database.
% unpack_tensor_double_1d [procedure,private, private] :: Unpack a 1d, 64-bit real tensor from the database.
% unpack_tensor_double_2d [procedure,private, private] :: Unpack a 2d, 64-bit real tensor from the database.
% unpack_tensor_double_3d [procedure,private, private] :: Unpack a 3d, 64-bit real tensor from the database.
% unpack_tensor_double_4d [procedure,private, private] :: Unpack a 4d, 64-bit real tensor from the database.
% unpack_tensor_int32_1d [procedure,private, private] :: Unpack a 1d, 32-bit integer tensor from the database.
% unpack_tensor_int32_2d [procedure,private, private] :: Unpack a 2d, 32-bit integer tensor from the database.
% unpack_tensor_int32_3d [procedure,private, private] :: Unpack a 3d, 32-bit integer tensor from the database.
% unpack_tensor_int32_4d [procedure,private, private] :: Unpack a 4d, 32-bit integer tensor from the database.

Function/Subroutine Documentation¶

function database_client_interface/sr_error_parser(self, response_code) [logical]¶

Decode a response code from an API function.

Parameters:

self :: [in] Receives the initialized client
response_code :: [in] The response code to decode

Return:

undefined :: Indicates whether this is an error response

function database_client_interface/initialize_client(self, cluster) [integer]¶

Initializes a new instance of a communication client.

Parameters:

self :: [inout] Receives the initialized client
cluster :: [in] If true, client uses a database cluster (Default: .false.)

function database_client_interface/isinitialized(this) [logical]¶: Check whether the client has been initialized.

function database_client_interface/destructor(self) [integer]¶: A destructor for the communication client.

function database_client_interface/put_tensor_float_1d(self, name, data, dims) [integer]¶

Put a 32-bit real 1d tensor into the database.

Parameters:

data :: [in] Data to be sent
self :: [in] Fortran communication client
name :: [in] The unique name used to store in the database
dims :: [in] The length of each dimension

Called from: