tidl_api/inc/configuration.h

   1 /******************************************************************************
   2  * Copyright (c) 2017-2018 Texas Instruments Incorporated - http://www.ti.com/
   3  *  All rights reserved.
   4  *
   5  *  Redistribution and use in source and binary forms, with or without
   6  *  modification, are permitted provided that the following conditions are met:
   7  *      * Redistributions of source code must retain the above copyright
   8  *        notice, this list of conditions and the following disclaimer.
   9  *      * Redistributions in binary form must reproduce the above copyright
  10  *        notice, this list of conditions and the following disclaimer in the
  11  *        documentation and/or other materials provided with the distribution.
  12  *      * Neither the name of Texas Instruments Incorporated nor the
  13  *        names of its contributors may be used to endorse or promote products
  14  *        derived from this software without specific prior written permission.
  15  *
  16  *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  17  *  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18  *  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19  *  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  20  *  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  21  *  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  22  *  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  23  *  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  24  *  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  25  *  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  26  *  THE POSSIBILITY OF SUCH DAMAGE.
  27  *****************************************************************************/
  28
  29 #pragma once
  30
  31 //! @file configuration.h
  32
  33 #include <string>
  34 #include <iostream>
  35
  36 namespace tidl {
  37
  38 /*! @class Configuration
  39     @brief Specifies the configuration required for a network
  40 */
  41 class Configuration
  42 {
  43   public:
  44
  45     //! Number of frames of input data (can be 0 if data is not read from file)
  46     int     numFrames;
  47
  48     //! Height of the input frame
  49     int     inHeight;
  50
  51     //! Width of the input frame
  52     int     inWidth;
  53
  54     //! Number of channels in the input frame (e.g. 3 for BGR)
  55     int     inNumChannels;
  56     int     noZeroCoeffsPercentage;
  57
  58     //! Pre-processing type applied to the input frame
  59     //! Specific to each network, can take values from 0 to 4, default is 0
  60     int     preProcType;
  61
  62     //! Force to run all layers, regardless of layersGroupId partitioning
  63     bool    runFullNet;
  64
  65     //! When set, inputs are taken from TIDL internal buffers that contain
  66     //! outputs of previous layersGroupId, instead of from user application
  67     bool     enableInternalInput;
  68
  69     //! Size of the TI DL per Execution Object heap
  70     size_t EXTMEM_HEAP_SIZE;
  71
  72     //! Size of the heap used for paramter data
  73     size_t PARAM_HEAP_SIZE;
  74
  75     //! @brief Location of the input file
  76     //! Can be empty if input data is provided by frameworks such as OpenCV.
  77     std::string inData;
  78
  79     //! Location of the output file
  80     //! Can be empty if output data is consumed by frameworks such as OpenCV.
  81     std::string outData;
  82
  83     //! Path to the TIDL network binary file
  84     std::string netBinFile;
  85
  86     //! Path to the TIDL parameter binary file
  87     std::string paramsBinFile;
  88
  89     //! Enable tracing of output buffers associated with each layer
  90     bool enableOutputTrace;
  91
  92     //! Default constructor.
  93     Configuration();
  94
  95     //! Validate the fields in the configuration object
  96     bool Validate() const;
  97
  98     //! Print the configuration
  99     void Print(std::ostream& os = std::cout) const;
 100
 101     //! Read a configuration from the specified file and validate
 102     bool ReadFromFile(const std::string& file_name);
 103 };
 104
 105 }