Documentation and top-level makefile updates
authorAjay Jayaraj <ajayj@ti.com>
Thu, 28 Jun 2018 22:35:05 +0000 (17:35 -0500)
committerAjay Jayaraj <ajayj@ti.com>
Thu, 28 Jun 2018 22:35:05 +0000 (17:35 -0500)
(MCT-1008)

docs/source/building.rst [new file with mode: 0644]
docs/source/example.rst
docs/source/index.rst
docs/source/using_api.rst
makefile

diff --git a/docs/source/building.rst b/docs/source/building.rst
new file mode 100644 (file)
index 0000000..c507550
--- /dev/null
@@ -0,0 +1,5 @@
+*********************
+Building from sources
+*********************
+
+Source for the TIDL API is available at https://git.ti.com/tidl/tidl-api. ``tidl-api/makefile`` contains targets to build the API, viewer and examples. The makefile supports native compilation on the EVM and cross-compilation on x86/Linux.
index 73f88f6067fb6e0a8e396bedf1b968c7a6a2ce5d..eed7a43e450bff02f96b23ad60c36c6f1ae9a3e7 100644 (file)
@@ -4,16 +4,16 @@ Examples
 
 We ship three end-to-end examples within the tidl-api package
 to demonstrate three categories of deep learning networks.  The first
-two examples can run on AM57x SoCs with either EVE or DSP.  The last
+two examples can run on AM57x SoCs with either EVE or DSP devices.  The last
 example requires AM57x SoCs with both EVE and DSP.  The performance
 numbers that we present here were obtained on an AM5729 EVM, which
 includes 2 ARM A15 cores running at 1.5GHz, 4 EVE cores at 535MHz, and
 2 DSP cores at 750MHz.
 
 For each example, we report device processing time, host processing time,
-and TIDL API overhead.  Device processing time is measured on the device,
-from the moment processing starts till the moment processing finishes.
-Host processing time is measured on the host, from the moment
+and TIDL API overhead.  **Device processing time** is measured on the device,
+from the moment processing starts for a frame till processing finishes.
+**Host processing time** is measured on the host, from the moment
 ``ProcessFrameStartAsync()`` is called till ``ProcessFrameWait()`` returns
 in user application.  It includes the TIDL API overhead, the OpenCL runtime
 overhead, and the time to copy user input data into padded TIDL internal
@@ -132,7 +132,7 @@ to an *Executor* and how easy it is to connect the output from one
 Running Examples
 ----------------
 
-The examples are located in ``/usr/share/ti/tidl-api/examples`` on
+The examples are located in ``/usr/share/ti/tidl/examples`` on
 the EVM file system.  Each example needs to be run its own directory.
 Running an example with ``-h`` will show help message with option set.
 The following code section shows how to run the examples, and
index a094db58373504974310195c7466d07ae1e39524..ec32a6b2c40e41681ff1337169721ac96964176b 100644 (file)
@@ -12,6 +12,7 @@ TI Deep Learning API User's Guide
    viewer
    example
    api
+   building
    faq/index
    notice
    disclaimer
index 02c24ff82438928a9f6528901f2697660ba68465..51ca13f53d0c304de74edfb910d9fc1c0a302bf3 100644 (file)
@@ -77,6 +77,6 @@ Run the network on each input frame.  The frames are processed with available ex
                 eo->ProcessFrameStartAsync();
         }
 
-For a complete example of using the API, refer any of the examples available at ``/usr/share/ti/tidl-api/examples`` on the EVM file system.
+For a complete example of using the API, refer any of the examples available at ``/usr/share/ti/tidl/examples`` on the EVM file system.
 
 .. _Processor SDK Linux Software Developer's Guide: http://software-dl.ti.com/processor-sdk-linux/esd/docs/latest/linux/index.html
index 341d4444ff72fa3e6933601043bbf243fa66cb4c..f8ea211dae89a620f8b9b7df884f09480663280d 100644 (file)
--- a/makefile
+++ b/makefile
 # THE POSSIBILITY OF SUCH DAMAGE.
 
 
-# makefile for building from the tidl-api git repi
-# Required TARGET_ROOTDIR to be set.
+# makefile for building from the tidl-api git repo
+# Cross-compilation requires TARGET_ROOTDIR to be set.
+# E.g.
+# PSDK_LINUX=<path to Processor Linux SDK install>
+# TARGET_ROOTDIR=$PSDK_LINUX/linux-devkit/sysroots/armv7ahf-neon-linux-gnueabi
 
 ifneq (,$(findstring 86, $(shell uname -m)))
 DEST_DIR ?= $(CURDIR)/install/am57
+VIEWER_TARGET=x86
+else
+VIEWER_TARGET=arm
 endif
 
 INSTALL_DIR_API = $(DEST_DIR)/usr/share/ti/tidl
 INSTALL_DIR_EXAMPLES = $(DEST_DIR)/usr/share/ti/examples/tidl
 
-CP_ARGS=-Prf --preserve=mode,timestamps --no-preserve=ownership
+CP_ARGS = -Prf
+ifneq (,$(findstring 86, $(shell uname -m)))
+CP_ARGS += --preserve=mode,timestamps --no-preserve=ownership
+endif
 
 build-api:
        $(MAKE) -C tidl_api
@@ -56,5 +65,9 @@ install-examples: build-examples
        mkdir -p $(INSTALL_DIR_EXAMPLES)
        cp $(CP_ARGS) examples/* $(INSTALL_DIR_EXAMPLES)/
 
+build-viewer:
+       $(MAKE) TARGET=$(VIEWER_TARGET) -C viewer
+
 clean:
        $(MAKE) -C tidl_api     clean
+       $(MAKE) -C examples     clean