SOPHON-SAIL 用户手册

目录

• 1. 声明
• 2. SAIL
• 3. 编译安装指南
  • 3.1. 源码目录结构
  • 3.2. SAIL的编译参数
  • 3.3. Python SAIL的编译与安装
    • 3.3.1. 编译可被Python3接口调用的Wheel文件
      • 3.3.1.1. PCIE MODE
      • 3.3.1.2. SOC MODE
      • 3.3.1.3. ARM PCIE MODE
      • 3.3.1.4. LOONGARCH64 MODE
      • 3.3.1.5. RISCV MODE
      • 3.3.1.6. WINDOWS MODE
    • 3.3.2. 使用SAIL的Python接口进行开发
      • 3.3.2.1. PCIE MODE
      • 3.3.2.2. SOC MODE
      • 3.3.2.3. ARM PCIE MODE
  • 3.4. C++ SAIL的编译与安装
    • 3.4.1. 编译可被C++接口调用的动态库及头文件
      • 3.4.1.1. PCIE MODE
      • 3.4.1.2. SOC MODE
      • 3.4.1.3. ARM PCIE MODE
      • 3.4.1.4. LOONGARCH64 MODE
      • 3.4.1.5. RISCV MODE
      • 3.4.1.6. WINDOWS MODE
    • 3.4.2. 使用SAIL的C++接口进行开发
      • 3.4.2.1. PCIE MODE
      • 3.4.2.2. SOC MODE
      • 3.4.2.3. ARM PCIE MODE
  • 3.5. 编译用户手册
• 4. SAIL C++ API 参考
  • 4.1. Basic function
    • 4.1.1. get_available_tpu_num
    • 4.1.2. set_print_flag
    • 4.1.3. set_dump_io_flag
    • 4.1.4. set_loglevel
    • 4.1.5. set_decoder_env
    • 4.1.6. base64_enc
    • 4.1.7. base64_dec
    • 4.1.8. get_tpu_util
    • 4.1.9. get_vpu_util
    • 4.1.10. get_vpp_util
    • 4.1.11. get_board_temp
    • 4.1.12. get_chip_temp
    • 4.1.13. get_dev_stat
  • 4.2. SAIL 枚举类型
    • 4.2.1. LogLevel
    • 4.2.2. Data type
    • 4.2.3. Format
    • 4.2.4. ImgDtype
    • 4.2.5. IOMode
    • 4.2.6. bmcv_resize_algorithm
    • 4.2.7. sail_resize_type
    • 4.2.8. DecoderStatus
  • 4.3. PaddingAtrr
    • 4.3.1. 构造函数PaddingAtrr()
    • 4.3.2. set_stx
    • 4.3.3. set_sty
    • 4.3.4. set_w
    • 4.3.5. set_h
    • 4.3.6. set_r
    • 4.3.7. set_g
    • 4.3.8. set_b
  • 4.4. Handle
    • 4.4.1. 构造函数
    • 4.4.2. get_device_id
    • 4.4.3. get_sn
    • 4.4.4. get_target
  • 4.5. Tensor
    • 4.5.1. 构造函数
    • 4.5.2. shape
    • 4.5.3. dtype
    • 4.5.4. scale_from
    • 4.5.5. scale_to
    • 4.5.6. reshape
    • 4.5.7. own_sys_data
    • 4.5.8. own_dev_data
    • 4.5.9. sync_s2d
    • 4.5.10. sync_d2s
    • 4.5.11. sync_d2d
    • 4.5.12. sync_d2d_stride
    • 4.5.13. dump_data
    • 4.5.14. memory_set
    • 4.5.15. memory_set
    • 4.5.16. zeros
    • 4.5.17. ones
    • 4.5.18. size
    • 4.5.19. element_size
    • 4.5.20. nbytes
  • 4.6. Engine
    • 4.6.1. 构造函数
    • 4.6.2. get_handle
    • 4.6.3. load
    • 4.6.4. get_graph_names
    • 4.6.5. set_io_mode
    • 4.6.6. graph_is_dynamic
    • 4.6.7. get_input_names
    • 4.6.8. get_output_names
    • 4.6.9. get_max_input_shapes
    • 4.6.10. get_input_shape
    • 4.6.11. get_max_output_shapes
    • 4.6.12. get_output_shape
    • 4.6.13. get_input_dtype
    • 4.6.14. get_output_dtype
    • 4.6.15. get_input_scale
    • 4.6.16. get_output_scale
    • 4.6.17. process
    • 4.6.18. get_device_id
    • 4.6.19. create_input_tensors_map
    • 4.6.20. create_output_tensors_map
  • 4.7. MultiEngine
    • 4.7.1. MultiEngine
    • 4.7.2. set_print_flag
    • 4.7.3. set_print_time
    • 4.7.4. get_device_ids
    • 4.7.5. get_graph_names
    • 4.7.6. get_input_names
    • 4.7.7. get_output_names
    • 4.7.8. get_input_shape
    • 4.7.9. get_output_shape
    • 4.7.10. process
  • 4.8. bm_image
  • 4.9. BMImage
    • 4.9.1. 构造函数
    • 4.9.2. width
    • 4.9.3. height
    • 4.9.4. format
    • 4.9.5. dtype
    • 4.9.6. data
    • 4.9.7. get_device_id
    • 4.9.8. get_handle
    • 4.9.9. get_plane_num
    • 4.9.10. align
    • 4.9.11. check_align
    • 4.9.12. unalign
    • 4.9.13. check_contiguous_memory
  • 4.10. BMImageArray
    • 4.10.1. 构造函数
    • 4.10.2. copy_from
    • 4.10.3. attach_from
    • 4.10.4. get_device_id
  • 4.11. Decoder
    • 4.11.1. 构造函数
    • 4.11.2. is_opened
    • 4.11.3. read
    • 4.11.4. read_
    • 4.11.5. get_frame_shape
    • 4.11.6. release
    • 4.11.7. reconnect
    • 4.11.8. enable_dump
    • 4.11.9. disable_dump
    • 4.11.10. dump
    • 4.11.11. get_pts_dts
  • 4.12. Encoder
    • 4.12.1. 构造函数
    • 4.12.2. is_opened
    • 4.12.3. pic_encode
    • 4.12.4. video_write
    • 4.12.5. release
  • 4.13. Decoder_RawStream
    • 4.13.1. 构造函数
    • 4.13.2. read
    • 4.13.3. read_
    • 4.13.4. release
  • 4.14. Bmcv
    • 4.14.1. 构造函数
    • 4.14.2. bm_image_to_tensor
    • 4.14.3. tensor_to_bm_image
    • 4.14.4. crop_and_resize
    • 4.14.5. crop
    • 4.14.6. resize
    • 4.14.7. vpp_crop_and_resize
    • 4.14.8. vpp_crop_and_resize_padding
    • 4.14.9. vpp_crop
    • 4.14.10. vpp_resize
    • 4.14.11. vpp_resize_padding
    • 4.14.12. warp
    • 4.14.13. convert_to
    • 4.14.14. yuv2bgr
    • 4.14.15. rectangle
    • 4.14.16. fillRectangle
    • 4.14.17. imwrite
    • 4.14.18. imwrite
    • 4.14.19. get_handle
    • 4.14.20. crop_and_resize_padding
    • 4.14.21. convert_format
    • 4.14.22. vpp_convert_format
    • 4.14.23. putText
    • 4.14.24. image_add_weighted
    • 4.14.25. image_copy_to
    • 4.14.26. image_copy_to_padding
    • 4.14.27. nms
    • 4.14.28. drawPoint
    • 4.14.29. warp_perspective
    • 4.14.30. get_bm_data_type
    • 4.14.31. get_bm_image_data_format
    • 4.14.32. imdecode
    • 4.14.33. imencode
    • 4.14.34. fft
    • 4.14.35. convert_yuv420p_to_gray
    • 4.14.36. watermark_superpose
    • 4.14.37. polylines
    • 4.14.38. mosaic
    • 4.14.39. gaussian_blur
    • 4.14.40. transpose
    • 4.14.41. Sobel
    • 4.14.42. drawLines
    • 4.14.43. stft
    • 4.14.44. istft
    • 4.14.45. faiss_indexflatL2
    • 4.14.46. faiss_indexflatIP
    • 4.14.47. faiss_indexPQ_encode
    • 4.14.48. faiss_indexPQ_ADC
    • 4.14.49. faiss_indexPQ_SDC
  • 4.15. Blend
    • 4.15.1. 构造函数Blend()
    • 4.15.2. process
  • 4.16. MultiDecoder
    • 4.16.1. 构造函数
    • 4.16.2. set_read_timeout
    • 4.16.3. add_channel
    • 4.16.4. del_channel
    • 4.16.5. clear_queue
    • 4.16.6. read
    • 4.16.7. read_
    • 4.16.8. reconnect
    • 4.16.9. get_frame_shape
    • 4.16.10. set_local_flag
    • 4.16.11. get_channel_fps
    • 4.16.12. reset_drop_num
    • 4.16.13. get_channel_status
  • 4.17. SAIL C++ 高性能接口
    • 4.17.1. ImagePreProcess
      • 4.17.1.1. 构造函数
      • 4.17.1.2. SetResizeImageAtrr
      • 4.17.1.3. SetPaddingAtrr
      • 4.17.1.4. SetConvertAtrr
      • 4.17.1.5. PushImage
      • 4.17.1.6. GetBatchData
      • 4.17.1.7. set_print_flag
    • 4.17.2. TensorPTRWithName
    • 4.17.3. EngineImagePreProcess
      • 4.17.3.1. 构造函数
      • 4.17.3.2. InitImagePreProcess
      • 4.17.3.3. SetPaddingAtrr
      • 4.17.3.4. SetConvertAtrr
      • 4.17.3.5. PushImage
      • 4.17.3.6. GetBatchData
      • 4.17.3.7. GetBatchData_CV
      • 4.17.3.8. get_graph_name
      • 4.17.3.9. get_input_width
      • 4.17.3.10. get_input_height
      • 4.17.3.11. get_output_names
      • 4.17.3.12. get_output_shape
    • 4.17.4. Yolov5 后处理加速接口
      • 4.17.4.1. algo_yolov5_post_1output
      • 4.17.4.2. algo_yolov5_post_3output
      • 4.17.4.3. algo_yolov5_post_cpu_opt
      • 4.17.4.4. algo_yolov5_post_cpu_opt_async
      • 4.17.4.5. tpu_kernel_api_yolov5_detect_out
      • 4.17.4.6. tpu_kernel_api_yolov5_out_without_decode
    • 4.17.5. Yolox后处理加速接口
      • 4.17.5.1. algo_yolox_post
    • 4.17.6. Yolov8后处理加速接口
      • 4.17.6.1. algo_yolov8_post_1output_async
      • 4.17.6.2. algo_yolov8_post_cpu_opt_1output_async
    • 4.17.7. sort 算法
      • 4.17.7.1. sort_tracker_controller
      • 4.17.7.2. deepsort_tracker_controller_async
    • 4.17.8. deepsort 算法
      • 4.17.8.1. deepsort_tracker_controller
      • 4.17.8.2. deepsort_tracker_controller_async
    • 4.17.9. bytetrack 算法
      • 4.17.9.1. bytetrack_tracker_controller
    • 4.17.10. openpose 算法
      • 4.17.10.1. tpu_kernel_api_openpose_part_nms
• 5. SAIL Python API 参考
  • 5.1. Basic function
    • 5.1.1. get_available_tpu_num
    • 5.1.2. set_print_flag
    • 5.1.3. set_dump_io_flag
    • 5.1.4. set_loglevel
    • 5.1.5. set_decoder_env
    • 5.1.6. base64_encode
    • 5.1.7. base64_decode
    • 5.1.8. base64_encode_array
    • 5.1.9. base64_decode_asarray
    • 5.1.10. get_tpu_util
    • 5.1.11. get_vpu_util
    • 5.1.12. get_vpp_util
    • 5.1.13. get_board_temp
    • 5.1.14. get_chip_temp
    • 5.1.15. get_dev_stat
  • 5.2. SAIL 枚举类型
    • 5.2.1. sail.LogLevel
    • 5.2.2. sail.Data type
    • 5.2.3. sail.Format
    • 5.2.4. sail.ImgDtype
    • 5.2.5. sail.IOMode
    • 5.2.6. sail.bmcv_resize_algorithm
    • 5.2.7. sail.sail_resize_type
    • 5.2.8. sail.DecoderStatus
    • 5.2.9. sail.BmrtFlag
  • 5.3. sail.Handle
    • 5.3.1. __init__
    • 5.3.2. get_device_id
    • 5.3.3. get_sn
    • 5.3.4. get_target
  • 5.4. sail.Tensor
    • 5.4.1. __init__
    • 5.4.2. shape
    • 5.4.3. dtype
    • 5.4.4. asnumpy
    • 5.4.5. update_data
    • 5.4.6. scale_from
    • 5.4.7. scale_to
    • 5.4.8. reshape
    • 5.4.9. own_sys_data
    • 5.4.10. own_dev_data
    • 5.4.11. sync_s2d
    • 5.4.12. sync_d2s
    • 5.4.13. sync_d2d
    • 5.4.14. sync_d2d_stride
    • 5.4.15. dump_data
    • 5.4.16. memory_set
    • 5.4.17. zeros
    • 5.4.18. ones
    • 5.4.19. size
    • 5.4.20. element_size
    • 5.4.21. nbytes
  • 5.5. sail.PaddingAtrr
    • 5.5.1. __init__
    • 5.5.2. set_stx
    • 5.5.3. set_sty
    • 5.5.4. set_w
    • 5.5.5. set_h
    • 5.5.6. set_r
    • 5.5.7. set_g
    • 5.5.8. set_b
  • 5.6. sail.Engine
    • 5.6.1. __init__
    • 5.6.2. get_handle
    • 5.6.3. load
    • 5.6.4. get_graph_names
    • 5.6.5. set_io_mode
    • 5.6.6. graph_is_dynamic
    • 5.6.7. get_input_names
    • 5.6.8. get_output_names
    • 5.6.9. get_max_input_shapes
    • 5.6.10. get_input_shape
    • 5.6.11. get_max_output_shapes
    • 5.6.12. get_output_shape
    • 5.6.13. get_input_dtype
    • 5.6.14. get_output_dtype
    • 5.6.15. get_input_scale
    • 5.6.16. get_output_scale
    • 5.6.17. process
    • 5.6.18. get_device_id
    • 5.6.19. create_input_tensors_map
    • 5.6.20. create_output_tensors_map
  • 5.7. sail.EngineLLM
    • 5.7.1. 通用参数说明
    • 5.7.2. 构造函数 __init__
    • 5.7.3. 推理接口 process
    • 5.7.4. 获取信息接口
      • 5.7.4.1. get_device_ids
      • 5.7.4.2. get_graph_names
      • 5.7.4.3. get_addr_mode
      • 5.7.4.4. get_stage_num
      • 5.7.4.5. get_input_num
      • 5.7.4.6. get_output_num
      • 5.7.4.7. get_is_dynamic
      • 5.7.4.8. get_input_name
      • 5.7.4.9. get_output_name
      • 5.7.4.10. get_input_tensor_devid
      • 5.7.4.11. get_output_tensor_devid
      • 5.7.4.12. get_input_shape
      • 5.7.4.13. get_output_shape
      • 5.7.4.14. get_input_max_shape
      • 5.7.4.15. get_output_max_shape
      • 5.7.4.16. get_input_dtype
      • 5.7.4.17. get_output_dtype
      • 5.7.4.18. get_input_scale
      • 5.7.4.19. get_output_scale
    • 5.7.5. 创建Tensor接口
      • 5.7.5.1. get_input_tensors
      • 5.7.5.2. get_input_tensor
      • 5.7.5.3. get_output_tensors
      • 5.7.5.4. get_output_tensor
      • 5.7.5.5. get_input_tensors_addrmode0
      • 5.7.5.6. get_output_tensors_addrmode0
  • 5.8. sail.MultiEngine
    • 5.8.1. MultiEngine
    • 5.8.2. set_print_flag
    • 5.8.3. set_print_time
    • 5.8.4. get_device_ids
    • 5.8.5. get_graph_names
    • 5.8.6. get_input_names
    • 5.8.7. get_output_names
    • 5.8.8. get_input_shape
    • 5.8.9. get_output_shape
    • 5.8.10. process
  • 5.9. sail.bm_image
  • 5.10. sail.BMImage
    • 5.10.1. __init__
    • 5.10.2. width
    • 5.10.3. height
    • 5.10.4. format
    • 5.10.5. dtype
    • 5.10.6. data
    • 5.10.7. get_device_id
    • 5.10.8. get_handle
    • 5.10.9. asmat
    • 5.10.10. asnumpy
    • 5.10.11. get_plane_num
    • 5.10.12. align
    • 5.10.13. check_align
    • 5.10.14. unalign
    • 5.10.15. check_contiguous_memory
  • 5.11. sail.BMImageArray
    • 5.11.1. __init__
    • 5.11.2. __getitem__
    • 5.11.3. __setitem__
    • 5.11.4. copy_from
    • 5.11.5. attach_from
    • 5.11.6. get_device_id
  • 5.12. sail.Decoder
    • 5.12.1. __init__
    • 5.12.2. is_opened
    • 5.12.3. read
    • 5.12.4. read_
    • 5.12.5. get_frame_shape
    • 5.12.6. release
    • 5.12.7. reconnect
    • 5.12.8. enable_dump
    • 5.12.9. disable_dump
    • 5.12.10. dump
    • 5.12.11. get_pts_dts
  • 5.13. sail.Encoder
    • 5.13.1. __init__
    • 5.13.2. is_opened
    • 5.13.3. pic_encode
    • 5.13.4. video_write
    • 5.13.5. release
  • 5.14. sail.Decoder_RawStream
    • 5.14.1. __init__
    • 5.14.2. read
    • 5.14.3. read_
    • 5.14.4. release
  • 5.15. sail.Bmcv
    • 5.15.1. __init__
    • 5.15.2. bm_image_to_tensor
    • 5.15.3. tensor_to_bm_image
    • 5.15.4. crop_and_resize
    • 5.15.5. crop
    • 5.15.6. resize
    • 5.15.7. vpp_crop_and_resize
    • 5.15.8. vpp_crop_and_resize_padding
    • 5.15.9. vpp_crop
    • 5.15.10. vpp_resize
    • 5.15.11. vpp_resize_padding
    • 5.15.12. warp
    • 5.15.13. convert_to
    • 5.15.14. yuv2bgr
    • 5.15.15. rectangle
    • 5.15.16. fillRectangle
    • 5.15.17. imwrite
    • 5.15.18. imread
    • 5.15.19. get_handle
    • 5.15.20. crop_and_resize_padding
    • 5.15.21. convert_format
    • 5.15.22. vpp_convert_format
    • 5.15.23. putText
    • 5.15.24. image_add_weighted
    • 5.15.25. image_copy_to
    • 5.15.26. image_copy_to_padding
    • 5.15.27. nms
    • 5.15.28. drawPoint
    • 5.15.29. warp_perspective
    • 5.15.30. get_bm_data_type
    • 5.15.31. get_bm_image_data_format
    • 5.15.32. imdecode
    • 5.15.33. imencode
    • 5.15.34. fft
    • 5.15.35. convert_yuv420p_to_gray
    • 5.15.36. mat_to_bm_image
    • 5.15.37. watermark_superpose
    • 5.15.38. polylines
    • 5.15.39. mosaic
    • 5.15.40. gaussian_blur
    • 5.15.41. transpose
    • 5.15.42. Sobel
    • 5.15.43. drawLines
    • 5.15.44. stft
    • 5.15.45. istft
    • 5.15.46. bmcv_overlay
    • 5.15.47. faiss_indexflatL2
    • 5.15.48. faiss_indexflatIP
    • 5.15.49. faiss_indexPQ_encode
    • 5.15.50. faiss_indexPQ_ADC
    • 5.15.51. faiss_indexPQ_SDC
  • 5.16. sail.Blend
    • 5.16.1. __init__
    • 5.16.2. process
  • 5.17. sail.MultiDecoder
    • 5.17.1. __init__
    • 5.17.2. set_read_timeout
    • 5.17.3. add_channel
    • 5.17.4. del_channel
    • 5.17.5. clear_queue
    • 5.17.6. read
    • 5.17.7. read_
    • 5.17.8. reconnect
    • 5.17.9. get_frame_shape
    • 5.17.10. set_local_flag
    • 5.17.11. get_channel_fps
    • 5.17.12. reset_drop_num
    • 5.17.13. get_channel_status
  • 5.18. SAIL Python 高性能接口
    • 5.18.1. sail.TensorPTRWithName
      • 5.18.1.1. get_name
      • 5.18.1.2. get_data
    • 5.18.2. sail.ImagePreProcess
      • 5.18.2.1. __init__
      • 5.18.2.2. SetResizeImageAtrr
      • 5.18.2.3. SetPaddingAtrr
      • 5.18.2.4. SetConvertAtrr
      • 5.18.2.5. PushImage
      • 5.18.2.6. GetBatchData
      • 5.18.2.7. set_print_flag
    • 5.18.3. sail.EngineImagePreProcess
      • 5.18.3.1. __init__
      • 5.18.3.2. InitImagePreProcess
      • 5.18.3.3. SetPaddingAtrr
      • 5.18.3.4. SetConvertAtrr
      • 5.18.3.5. PushImage
      • 5.18.3.6. GetBatchData_Npy
      • 5.18.3.7. GetBatchData_Npy2
      • 5.18.3.8. GetBatchData
      • 5.18.3.9. get_graph_name
      • 5.18.3.10. get_input_width
      • 5.18.3.11. get_input_height
      • 5.18.3.12. get_output_names
      • 5.18.3.13. get_output_shape
    • 5.18.4. Yolov5 后处理加速接口
      • 5.18.4.1. sail.algo_yolov5_post_1output
      • 5.18.4.2. sail.algo_yolov5_post_3output
      • 5.18.4.3. sail.algo_yolov5_post_cpu_opt
      • 5.18.4.4. sail.algo_yolov5_post_cpu_opt_async
      • 5.18.4.5. sail.tpu_kernel_api_yolov5_detect_out
      • 5.18.4.6. sail.tpu_kernel_api_yolov5_out_without_decode
    • 5.18.5. Yolox后处理加速接口
      • 5.18.5.1. sail.algo_yolox_post
    • 5.18.6. Yolov8后处理加速接口
      • 5.18.6.1. sail.algo_yolov8_post_1output_async
      • 5.18.6.2. sail.algo_yolov8_post_cpu_opt_1output_async
    • 5.18.7. sort 算法
      • 5.18.7.1. sort_tracker_controller
      • 5.18.7.2. sort_tracker_controller_async
    • 5.18.8. deepsort 算法
      • 5.18.8.1. deepsort_tracker_controller
      • 5.18.8.2. deepsort_tracker_controller_async
    • 5.18.9. bytetrack 算法
      • 5.18.9.1. bytetrack_tracker_controller
    • 5.18.10. openpose 算法
      • 5.18.10.1. sail.tpu_kernel_api_openpose_part_nms
    • 5.18.11. nms_rotated 接口
      • 5.18.11.1. sail.nms_rotated
    • 5.18.12. Yolov8_seg TPU后处理加速接口
      • 5.18.12.1. sail.algo_yolov8_seg_post_tpu_opt
• 6. 附录
  • 6.1. 获取在X86主机上进行交叉编译的Python3
  • 6.2. 获取图片的权重文件