README.md

   1 # Jacinto-AI-DevKit (PyTorch)
   2
   3 ###### Notice:
   4 - If you have not visited our landing page in github, please do so: [https://github.com/TexasInstruments/jacinto-ai-devkit](https://github.com/TexasInstruments/jacinto-ai-devkit)
   5 - **Issue Tracker for jacinto-ai-devkit:** You can file issues or ask questions at **e2e**: [https://e2e.ti.com/support/processors/f/791/tags/jacinto_2D00_ai_2D00_devkit](https://e2e.ti.com/support/processors/f/791/tags/jacinto_2D00_ai_2D00_devkit). While creating a new issue kindly include **jacinto-ai-devkit** in the tags (as you create a new issue, there is a space to enter tags, at the bottom of the page).
   6 - **Issue Tracker for TIDL:** [https://e2e.ti.com/support/processors/f/791/tags/TIDL](https://e2e.ti.com/support/processors/f/791/tags/TIDL). Please include the tag **TIDL** (as you create a new issue, there is a space to enter tags, at the bottom of the page).
   7 - If you do not get a reply within two days, please contact us at: jacinto-ai-devkit@list.ti.com
   8
   9 ### Deep Learning Models / Training / Calibration & Quantization - Using PyTorch<br>
  10 This code provides a set of low complexity deep learning examples and models for low power embedded systems. Low power embedded systems often requires balancing of complexity and accuracy. This is a tough task and requires significant amount of expertise and experimentation. We call this process **complexity optimization**. In addition we would like to bridge the gap between Deep Learning training frameworks and real-time embedded inference by providing ready to use examples and enable **ease of use**. Scripts for training, validation, complexity analysis are also provided.
  11
  12 This code also includes tools for **Quantization Aware Training** that can output an 8-bit Quantization friendly model - these tools can be used to improve the quantized accuracy and bring it near floating point accuracy. For more details, please refer to the section on [Quantization](docs/Quantization.md).
  13
  14 **Several of these models have been verified to work on [TI's Jacinto7 Automotive Processors](http://www.ti.com/processors/automotive-processors/tdax-adas-socs/overview.html).** These tools and software are primarily intended as examples for learning and research.
  15
  16 ## Installation Instructions
  17 - These instructions are for installation on **Ubuntu 18.04**.
  18 - Install Anaconda with Python 3.7 or higher from https://www.anaconda.com/distribution/ <br>
  19 - After installation, make sure that your python is indeed Anaconda Python 3.7 or higher by typing:<br>
  20     ```
  21     python --version
  22     ```
  23 - Clone this repository into your local folder
  24 - Execute the following shell script to install the dependencies:<br>
  25     ```
  26     ./setup.sh
  27     ```
  28
  29 ## Examples
  30 The following examples are currently available. Click on each of the links below to go into the full description of the example.<br>
  31     <br>
  32 * **Image Classification**<br>
  33     - [**Image Classification**](docs/Image_Classification.md)<br>
  34     <br>
  35 * **Pixel2Pixel Prediction**<br>
  36     - [**Semantic Segmentation**](docs/Semantic_Segmentation.md)<br>
  37     - [Depth Estimation](docs/Depth_Estimation.md)<br>
  38     - [Motion Segmentation](docs/Motion_Segmentation.md)<br>
  39     - [**Multi Task Estimation**](docs/Multi_Task_Learning.md)<br>
  40     <br>
  41 * **Object Detection**<br>
  42     - Object Detection - coming soon..<br>
  43     - Object Keypoint Estimation - coming soon..<br>
  44     <br>
  45 * **Quantization**<br>
  46     - [**Quantization Aware Training**](docs/Quantization.md)<br>
  47     <br>
  48
  49
  50 Some of the common training and validation commands are provided in shell scripts (.sh files) in the root folder.
  51
  52 ## Additional Information
  53 For information on other similar devkits, please visit:<br>
  54 - Landing Page: [https://github.com/TexasInstruments/jacinto-ai-devkit](https://github.com/TexasInstruments/jacinto-ai-devkit)<br>
  55 - Actual Git Repositories: [https://git.ti.com/jacinto-ai-devkit](https://git.ti.com/jacinto-ai-devkit)<br>
  56
  57 ## Acknowledgements
  58
  59 Our source code uses parts of the following open source projects. We would like to sincerely thank their authors for making their code bases publicly available.
  60
  61 |Module/Functionality              |Parts of the code borrowed/modified from                                             |
  62 |----------------------------------|-------------------------------------------------------------------------------------|
  63 |Datasets, Models                  |https://github.com/pytorch/vision, https://github.com/ansleliu/LightNet              |
  64 |Training, Validation Engine/Loops |https://github.com/pytorch/examples, https://github.com/ClementPinard/FlowNetPytorch |
  65 |Object Detection                  |https://github.com/open-mmlab/mmdetection                                            |
  66
  67 ## License
  68
  69 Please see the [LICENSE](./LICENSE) file for more information about the license under which this code is made available.