libcoral API overview
The Coral C++ API (libcoral) is built atop the TensorFlow Lite C++ API to simplify your code when running an inference on the Edge TPU, and to provide advanced features for the Edge TPU such as model pipelining across multiple Edge TPUs, and on-device transfer learning.
For an introduction to using and building this library, see our guide to run inference on the Edge TPU with C++.
API summary
The libcoral API reference is organized into the following pages:
-
Includes various utility functions, such as
GetEdgeTpuContext()andMakeEdgeTpuInterpreter(), and helper APIs for image classification and object detection models. -
Includes APIs to pipeline a model with multiple Edge TPUs.
-
Includes APIs to perform on-device transfer learning, using either backpropagation or weight imprinting.
Complete API index
- coral::Allocator (C++ class)
- coral::Allocator::Alloc (C++ function)
- coral::Allocator::Free (C++ function)
- coral::BoxCornerEncoding (C++ struct)
- coral::BoxCornerEncoding::DebugString (C++ function)
- coral::BoxCornerEncoding::xmax (C++ member)
- coral::BoxCornerEncoding::xmin (C++ member)
- coral::BoxCornerEncoding::ymax (C++ member)
- coral::BoxCornerEncoding::ymin (C++ member)
- coral::CenterSizeEncoding (C++ struct)
- coral::CenterSizeEncoding::ConvertToBoxCornerEncoding (C++ function)
- coral::CenterSizeEncoding::DebugString (C++ function)
- coral::CenterSizeEncoding::h (C++ member)
- coral::CenterSizeEncoding::w (C++ member)
- coral::CenterSizeEncoding::x (C++ member)
- coral::CenterSizeEncoding::y (C++ member)
- coral::Class (C++ struct)
- coral::Class::id (C++ member)
- coral::Class::score (C++ member)
- coral::ComputeBoxArea (C++ function)
- coral::ContainsEdgeTpuCustomOp (C++ function)
- coral::CrossEntropyGradient (C++ function)
- coral::CrossEntropyLoss (C++ function)
- coral::Dequantize (C++ function), [1]
- coral::DequantizeTensor (C++ function)
- coral::FreeTensors (C++ function)
- coral::FullyConnected (C++ function)
- coral::FullyConnectedGradient (C++ function)
- coral::GetClassificationResults (C++ function), [1]
- coral::GetDetectionResults (C++ function), [1]
- coral::GetEdgeTpuContext (C++ function), [1]
- coral::GetEdgeTpuContextOrDie (C++ function), [1]
- coral::GetInputTensor (C++ function)
- coral::GetInputTensorNames (C++ function)
- coral::GetTopClassificationResult (C++ function)
- coral::ImprintingClass (C++ struct)
- coral::ImprintingClass::trainable (C++ member)
- coral::ImprintingClass::weights (C++ member)
- coral::ImprintingEngine (C++ class)
- coral::ImprintingEngine::classes_ (C++ member)
- coral::ImprintingEngine::Create (C++ function)
- coral::ImprintingEngine::embedding_dim (C++ function)
- coral::ImprintingEngine::ExtractorModelBuffer (C++ function)
- coral::ImprintingEngine::GetClasses (C++ function)
- coral::ImprintingEngine::ImprintingEngine (C++ function), [1]
- coral::ImprintingEngine::model_ (C++ member)
- coral::ImprintingEngine::operator= (C++ function)
- coral::ImprintingEngine::SerializeModel (C++ function)
- coral::ImprintingEngine::Train (C++ function)
- coral::ImprintingModel (C++ class)
- coral::ImprintingModel::Create (C++ function)
- coral::ImprintingModel::CreateOrDie (C++ function)
- coral::ImprintingModel::embedding_dim (C++ function)
- coral::ImprintingModel::embedding_dim_ (C++ member)
- coral::ImprintingModel::extractor_fbb_ (C++ member)
- coral::ImprintingModel::ExtractorModelBuffer (C++ function)
- coral::ImprintingModel::fc_quant_scale_ (C++ member)
- coral::ImprintingModel::fc_quant_zero_point_ (C++ member)
- coral::ImprintingModel::ImprintingModel (C++ function)
- coral::ImprintingModel::LoadExistingClasses (C++ function)
- coral::ImprintingModel::model_t_ (C++ member)
- coral::ImprintingModel::SerializeModel (C++ function)
- coral::IntersectionOverUnion (C++ function)
- coral::InvokeWithDmaBuffer (C++ function)
- coral::InvokeWithMemBuffer (C++ function)
- coral::IsBoxEmpty (C++ function)
- coral::LoadModelOrDie (C++ function), [1]
- coral::MakeEdgeTpuInterpreter (C++ function)
- coral::MakeEdgeTpuInterpreterOrDie (C++ function)
- coral::MatchShape (C++ function)
- coral::MultiVariateNormalDistribution (C++ class)
- coral::MultiVariateNormalDistribution::cov_ (C++ member)
- coral::MultiVariateNormalDistribution::dim_ (C++ member)
- coral::MultiVariateNormalDistribution::mean_ (C++ member)
- coral::MultiVariateNormalDistribution::MultiVariateNormalDistribution (C++ function)
- coral::MultiVariateNormalDistribution::p_ (C++ member)
- coral::MultiVariateNormalDistribution::rand_gaussian_ (C++ member)
- coral::MultiVariateNormalDistribution::Sample (C++ function)
- coral::MultiVariateNormalDistribution::solver_ (C++ member)
- coral::MutableTensorData (C++ function)
- coral::Object (C++ struct)
- coral::Object::bbox (C++ member)
- coral::Object::id (C++ member)
- coral::Object::score (C++ member)
- coral::operator!= (C++ function), [1], [2]
- coral::operator<< (C++ function), [1]
- coral::operator== (C++ function), [1], [2]
- coral::PipelinedModelRunner (C++ class)
- coral::PipelinedModelRunner::GetInputTensorAllocator (C++ function)
- coral::PipelinedModelRunner::GetOutputTensorAllocator (C++ function)
- coral::PipelinedModelRunner::GetSegmentStats (C++ function)
- coral::PipelinedModelRunner::PipelinedModelRunner (C++ function)
- coral::PipelinedModelRunner::Pop (C++ function)
- coral::PipelinedModelRunner::Push (C++ function)
- coral::PipelinedModelRunner::SetInputQueueSize (C++ function)
- coral::PipelinedModelRunner::SetOutputQueueSize (C++ function)
- coral::PipelineTensor (C++ struct)
- coral::PipelineTensor::buffer (C++ member)
- coral::PipelineTensor::bytes (C++ member)
- coral::PipelineTensor::type (C++ member)
- coral::Quantize (C++ function)
- coral::SegmentStats (C++ struct)
- coral::SegmentStats::num_inferences (C++ member)
- coral::SegmentStats::total_time_ns (C++ member)
- coral::SetTensorBuffer (C++ function)
- coral::SgdUpdate (C++ function)
- coral::Softmax (C++ function)
- coral::SoftmaxGradient (C++ function)
- coral::SoftmaxLocalGradient (C++ function)
- coral::SoftmaxRegressionModel (C++ class)
- coral::SoftmaxRegressionModel::AppendLayersToEmbeddingExtractor (C++ function)
- coral::SoftmaxRegressionModel::caches_ (C++ member)
- coral::SoftmaxRegressionModel::feature_dim_ (C++ member)
- coral::SoftmaxRegressionModel::GetAccuracy (C++ function)
- coral::SoftmaxRegressionModel::GetGrads (C++ function)
- coral::SoftmaxRegressionModel::GetLoss (C++ function)
- coral::SoftmaxRegressionModel::logit_max_ (C++ member)
- coral::SoftmaxRegressionModel::logit_min_ (C++ member)
- coral::SoftmaxRegressionModel::mat_w_ (C++ member)
- coral::SoftmaxRegressionModel::num_classes_ (C++ member)
- coral::SoftmaxRegressionModel::reg_ (C++ member)
- coral::SoftmaxRegressionModel::RunInference (C++ function)
- coral::SoftmaxRegressionModel::SoftmaxRegressionModel (C++ function)
- coral::SoftmaxRegressionModel::Train (C++ function)
- coral::SoftmaxRegressionModel::vec_b_ (C++ member)
- coral::SoftmaxRegressionModel::weight_scale_ (C++ member)
- coral::TensorData (C++ function)
- coral::TensorShape (C++ function)
- coral::TensorSize (C++ function)
- coral::ToString (C++ function), [1]
- coral::TrainConfig (C++ struct)
- coral::TrainConfig::batch_size (C++ member)
- coral::TrainConfig::num_iter (C++ member)
- coral::TrainConfig::print_every (C++ member)
- coral::TrainConfig::TrainConfig (C++ function)
- coral::TrainingData (C++ struct)
- coral::TrainingData::training_data (C++ member)
- coral::TrainingData::training_labels (C++ member)
- coral::TrainingData::validation_data (C++ member)
- coral::TrainingData::validation_labels (C++ member)
- edgetpu (C++ type)
- edgetpu::DeviceType (C++ enum)
- edgetpu::DeviceType::kApexPci (C++ enumerator)
- edgetpu::DeviceType::kApexUsb (C++ enumerator)
- edgetpu::EdgeTpuContext (C++ class)
- edgetpu::EdgeTpuContext::GetDeviceEnumRecord (C++ function)
- edgetpu::EdgeTpuContext::GetDeviceOptions (C++ function)
- edgetpu::EdgeTpuContext::IsReady (C++ function)
- edgetpu::EdgeTpuContext::~EdgeTpuContext (C++ function)
- edgetpu::EdgeTpuManager (C++ class)
- edgetpu::EdgeTpuManager::DeviceEnumerationRecord (C++ struct)
- edgetpu::EdgeTpuManager::DeviceEnumerationRecord::operator!= (C++ function)
- edgetpu::EdgeTpuManager::DeviceEnumerationRecord::operator== (C++ function)
- edgetpu::EdgeTpuManager::DeviceEnumerationRecord::path (C++ member)
- edgetpu::EdgeTpuManager::DeviceEnumerationRecord::type (C++ member)
- edgetpu::EdgeTpuManager::DeviceOptions (C++ type)
- edgetpu::EdgeTpuManager::EnumerateEdgeTpu (C++ function)
- edgetpu::EdgeTpuManager::GetOpenedDevices (C++ function)
- edgetpu::EdgeTpuManager::GetSingleton (C++ function)
- edgetpu::EdgeTpuManager::OpenDevice (C++ function), [1], [2], [3]
- edgetpu::EdgeTpuManager::SetVerbosity (C++ function)
- edgetpu::EdgeTpuManager::Version (C++ function)
- edgetpu::EdgeTpuManager::~EdgeTpuManager (C++ function)
- edgetpu::kCustomOp (C++ member)
Is this content helpful?