doxygen/html/rocal__api_8h_source.html

 /*

 MIT License

 Copyright (c) 2019 - 2023 Advanced Micro Devices, Inc. All rights reserved.


 Permission is hereby granted, free of charge, to any person obtaining a copy

 of this software and associated documentation files (the "Software"), to deal

 in the Software without restriction, including without limitation the rights

 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

 copies of the Software, and to permit persons to whom the Software is

 furnished to do so, subject to the following conditions:


 The above copyright notice and this permission notice shall be included in

 all copies or substantial portions of the Software.


 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE

 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN

 THE SOFTWARE.

 */


 #ifndef ROCAL_H

 #define ROCAL_H


 #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"


 extern "C" 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);


 extern "C" RocalStatus ROCAL_API_CALL rocalVerify(RocalContext context);


 extern "C" RocalStatus ROCAL_API_CALL rocalRun(RocalContext context);


 extern "C" RocalStatus ROCAL_API_CALL rocalRelease(RocalContext rocal_context);


 #endif

RocalStatus
RocalStatus
rocAL Status enum
Definition: rocal_api_types.h:112

RocalTensorOutputType
RocalTensorOutputType
rocAL Tensor Output Type enum
Definition: rocal_api_types.h:229

RocalProcessMode
RocalProcessMode
rocAL Process Mode enum
Definition: rocal_api_types.h:151

RocalContext
void * RocalContext
typedef void* rocAL Context
Definition: rocal_api_types.h:63

ROCAL_FP32
@ ROCAL_FP32
AMD ROCAL_FP32.
Definition: rocal_api_types.h:232

rocalCreate
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 interna...

rocalRelease
RocalStatus ROCAL_API_CALL rocalRelease(RocalContext rocal_context)
rocalRelease function to free all the resources allocated during the graph creation process.

rocalRun
RocalStatus ROCAL_API_CALL rocalRun(RocalContext context)
rocalRun function to process and run the built and verified graph.

rocalVerify
RocalStatus ROCAL_API_CALL rocalVerify(RocalContext context)
rocalVerify function to verify the graph for all the inputs and outputs

rocal_api_augmentation.h
The AMD rocAL Library - Augmentations.

rocal_api_data_loaders.h
The AMD rocAL Library - Data Loaders.

rocal_api_data_transfer.h
The AMD rocAL Library - Data Transfer.

rocal_api_info.h
The AMD rocAL Library - Info.

rocal_api_meta_data.h
The AMD rocAL Library - Meta Data.

rocal_api_parameters.h
The AMD rocAL Library - Parameters.

rocal_api_types.h
The AMD rocAL Library - Types.

ROCAL_API_CALL
#define ROCAL_API_CALL
Definition: rocal_api_types.h:35