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

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

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

Go to the documentation of this file.

 /*
 MIT License
 Copyright (c) 2019 - 2025 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"
  
 #define ROCAL_INVALID_CONTEXT_EXCEPTION(p_context) \
     do {                                           \
         if (p_context == nullptr)                  \
             THROW("Invalid rocal context")         \
     } while (0)
  
 #define ROCAL_INVALID_CONTEXT_ERR(p_context, output) \
     do {                                             \
         if (p_context == nullptr) {                  \
             ERR("Invalid rocal context")             \
             return output;                           \
         }                                            \
     } while (0)
  
 #define ROCAL_INVALID_INPUT_ERR(input, output) \
     do {                                       \
         if (input == nullptr) {                \
             ERR("Invalid input image")         \
             return output;                     \
         }                                      \
     } while (0)
  
 #define ROCAL_PRINT_EXCEPTION(context, e) \
     do {                                  \
         context->capture_error(e.what()); \
         std::cerr << e.what() << '\n';    \
     } while (0)
  
 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, bool enable_checkpointing = false);
  
 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);
  
 extern "C" RocalStatus ROCAL_API_CALL rocalSerialize(RocalContext rocal_context, size_t* serialized_string_size);
  
 extern "C" RocalStatus ROCAL_API_CALL rocalGetSerializedString(RocalContext rocal_context, char* serialized_string);
  
 extern "C" RocalContext ROCAL_API_CALL rocalDeserialize(const char* serialized_pipeline, size_t serialized_string_size, RocalPipelineParams* pipe_params);
  
 extern "C" RocalStatus ROCAL_API_CALL rocalCheckpoint(RocalContext rocal_context, size_t* serialized_ckpt_string_size);
  
 extern "C" RocalStatus ROCAL_API_CALL rocalGetSerializedCheckpointString(RocalContext rocal_context, char* serialized_ckpt_string);
  
 extern "C" RocalStatus ROCAL_API_CALL rocalRestoreFromSerializedCheckpoint(RocalContext rocal_context, const char* serialized_ckpt_string, size_t serialized_ckpt_size);
  
 #endif