nv::index::IInference_source_data Class Reference

Interface class exposes the source data that an inference technique can operate on. More...

#include <iinference_source_data.h>

Inherits mi::base::Interface_declare< 0xe455b9a0, ... >.

Public Member Functions
virtual mi::math::Bbox_struct< mi::Float32, 3 >	get_subregion_bbox () const =0
	Get the bounding box of the subregion for which the inference technique has been invoked. More...
virtual const IDistributed_data_subset *	get_distributed_data_subset () const =0
	Get distributed data subset representing the data stored locally inside the subregion. More...
virtual IDistributed_data_access *	get_distributed_data_access () const =0
	Get interface for accessing distributed data. More...
virtual mi::Sint32	get_device_id () const =0
	Get the id of the CUDA device on which the distributed data subset resides. More...

Detailed Description

Interface class exposes the source data that an inference technique can operate on.

The interface class is exposed through IDistributed_inference_technique.

Member Function Documentation

get_device_id()

virtual mi::Sint32 nv::index::IInference_source_data::get_device_id ( ) const

pure virtual

Get the id of the CUDA device on which the distributed data subset resides.

Returns the id of the CUDA device that stores the data of the distributed data subset. The device id might be required to leverage external contexts that are bound to a device, e.g., the CUDNN context, or buffers created and managed outside of NVIDIA IndeX that cache weights of neural network models.

Returns

Returns the CUDA device id to the calling inference implementation.

get_distributed_data_access()

virtual IDistributed_data_access * nv::index::IInference_source_data::get_distributed_data_access ( ) const

pure virtual

Get interface for accessing distributed data.

Returns s distribute data access interface for retrieve part or all of a dataset distributed in the cluster environment.

Returns

Returns an interface pointer to an instance of IDistributed_data_access.

Note

Future version will enable a user to request data beyond the data extent stored locally. This feature is currently not implemented.

get_distributed_data_subset()

virtual const IDistributed_data_subset * nv::index::IInference_source_data::get_distributed_data_subset ( ) const

pure virtual

Get distributed data subset representing the data stored locally inside the subregion.

Returns a subset of the distribute data that is contained in the local subregion. Subregions typically only store part subset of the entire distributed data. An inference technique may perform well on just the present subset. If the inference technique requires a larger extend or even the entire dataset, then the distributed data access needs to be called first (see create_distributed_data_access()).

Returns

Returns an interface pointer to an instance of IDistributed_data_subset.

get_subregion_bbox()

virtual mi::math::Bbox_struct< mi::Float32, 3 > nv::index::IInference_source_data::get_subregion_bbox ( ) const

pure virtual

Get the bounding box of the subregion for which the inference technique has been invoked.

The method returns the bounding box of the subregion for which the inference technique has been invoked by the NVIDIA IndeX system. The NVIDIA IndeX system initializes the bounding box that then can be accessed by an user-defined technique to control the inference parameter.

Returns

Returns the bounding box of the subregion that is defined in the subdivision space.

---

The documentation for this class was generated from the following file:

• iinference_source_data.h