/home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-rocal/checkouts/develop/rocAL/include/api/rocal_api.h File Reference

• rocAL
• include
• api

Macros | Functions

rocal_api.h File Reference

The AMD rocAL Library. More...

#include "rocal_api_types.h"
#include "rocal_api_tensor.h"
#include "rocal_api_parameters.h"
#include "rocal_api_data_loaders.h"
#include "rocal_api_augmentation.h"
#include "rocal_api_data_transfer.h"
#include "rocal_api_meta_data.h"
#include "rocal_api_info.h"

Go to the source code of this file.

Macros
#define	ROCAL_INVALID_CONTEXT_EXCEPTION(p_context)
#define	ROCAL_INVALID_CONTEXT_ERR(p_context, output)
#define	ROCAL_INVALID_INPUT_ERR(input, output)
#define	ROCAL_PRINT_EXCEPTION(context, e)

Functions
RocalContext ROCAL_API_CALL	rocalCreate (size_t batch_size, RocalProcessMode affinity, int gpu_id=0, size_t cpu_thread_count=1, size_t prefetch_queue_depth=3, RocalTensorOutputType output_tensor_data_type=RocalTensorOutputType::ROCAL_FP32)
	rocalCreate creates the context for a new augmentation pipeline. Initializes all the required internals for the pipeline More...
RocalStatus ROCAL_API_CALL	rocalVerify (RocalContext context)
	rocalVerify function to verify the graph for all the inputs and outputs More...
RocalStatus ROCAL_API_CALL	rocalRun (RocalContext context)
	rocalRun function to process and run the built and verified graph. More...
RocalStatus ROCAL_API_CALL	rocalRelease (RocalContext rocal_context)
	rocalRelease function to free all the resources allocated during the graph creation process. More...

Detailed Description

The AMD rocAL Library.

Macro Definition Documentation

◆ ROCAL_INVALID_CONTEXT_ERR

#define ROCAL_INVALID_CONTEXT_ERR	(		p_context,
			output
	)

Value:

do { \

if (p_context == nullptr) { \

ERR("Invalid rocal context") \

return output; \

} \

} while (0)

◆ ROCAL_INVALID_CONTEXT_EXCEPTION

#define ROCAL_INVALID_CONTEXT_EXCEPTION

(

p_context

)

Value:

do { \

if (p_context == nullptr) \

THROW("Invalid rocal context") \

} while (0)

◆ ROCAL_INVALID_INPUT_ERR

#define ROCAL_INVALID_INPUT_ERR	(		input,
			output
	)

Value:

do { \

if (input == nullptr) { \

ERR("Invalid input image") \

return output; \

} \

} while (0)

◆ ROCAL_PRINT_EXCEPTION

#define ROCAL_PRINT_EXCEPTION	(		context,
			e
	)

Value:

do { \

context->capture_error(e.what()); \

std::cerr << e.what() << '\n'; \

} while (0)