cpp-api.rst 849 Bytes
Newer Older
1
.. backends/cpp-api.rst:
2

3 4
Backend APIs 
############
5

Leona C's avatar
Leona C committed
6 7 8 9
.. toctree::
   :maxdepth: 1
   
   backend-api/index
10
   dynamicbackend-api/index
Leona C's avatar
Leona C committed
11
   plaidml-ng-api/index
Leona C's avatar
Leona C committed
12 13
   executable-api/index
   
14 15 16 17 18

As of version ``0.15``, there is a new backend API to work with functions that 
can be compiled as a runtime ``Executable``. Where previously ``Backend`` used a 
``shared_ptr<Function>`` as the handle passed to the ``call`` method to execute 
a compiled object, the addition of the ``shared_ptr<Executable>`` object has 
19 20
more direct methods to actions such as ``validate``, ``call``, ``get_performance_data``, 
and so on. This new API permits any executable to be saved or loaded *into* or 
21 22 23
*out of* storage and makes it easier to distinguish when a Function is compiled,
thus making the internals of the ``Backend`` and ``Executable`` easier to 
implement.