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

/home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-rocal/checkouts/docs-6.2.2/rocAL/include/api/rocal_api.h Source File#

rocAL: /home/docs/checkouts/readthedocs.org/user_builds/advanced-micro-devices-rocal/checkouts/docs-6.2.2/rocAL/include/api/rocal_api.h Source File
rocal_api.h
Go to the documentation of this file.
1 /*
2 MIT License
3 Copyright (c) 2019 - 2023 Advanced Micro Devices, Inc. All rights reserved.
4 
5 Permission is hereby granted, free of charge, to any person obtaining a copy
6 of this software and associated documentation files (the "Software"), to deal
7 in the Software without restriction, including without limitation the rights
8 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 copies of the Software, and to permit persons to whom the Software is
10 furnished to do so, subject to the following conditions:
11 
12 The above copyright notice and this permission notice shall be included in
13 all copies or substantial portions of the Software.
14 
15 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21 THE SOFTWARE.
22 */
23 
24 #ifndef ROCAL_H
25 #define ROCAL_H
26 
27 #include "rocal_api_types.h"
28 #include "rocal_api_tensor.h"
29 #include "rocal_api_parameters.h"
30 #include "rocal_api_data_loaders.h"
31 #include "rocal_api_augmentation.h"
33 #include "rocal_api_meta_data.h"
34 #include "rocal_api_info.h"
35 
55 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);
56 
65 
74 
83 
84 #endif
RocalStatus
rocAL Status enum
Definition: rocal_api_types.h:112
RocalTensorOutputType
rocAL Tensor Output Type enum
Definition: rocal_api_types.h:240
RocalProcessMode
rocAL Process Mode enum
Definition: rocal_api_types.h:151
void * RocalContext
typedef void* rocAL Context
Definition: rocal_api_types.h:63
@ ROCAL_FP32
AMD ROCAL_FP32.
Definition: rocal_api_types.h:243
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...
RocalStatus ROCAL_API_CALL rocalRelease(RocalContext rocal_context)
rocalRelease function to free all the resources allocated during the graph creation process.
RocalStatus ROCAL_API_CALL rocalRun(RocalContext context)
rocalRun function to process and run the built and verified graph.
RocalStatus ROCAL_API_CALL rocalVerify(RocalContext context)
rocalVerify function to verify the graph for all the inputs and outputs
The AMD rocAL Library - Augmentations.
The AMD rocAL Library - Data Loaders.
The AMD rocAL Library - Data Transfer.
The AMD rocAL Library - Info.
The AMD rocAL Library - Meta Data.
The AMD rocAL Library - Parameters.
The AMD rocAL Library - Types.
#define ROCAL_API_CALL
Definition: rocal_api_types.h:35