release commit
[jacinto-ai/pytorch-jacinto-ai-devkit.git] / README.md
index 510711c0e358218f67304c720b0c3d6675eaee7e..b4b321e70a1cf507a7a9b6adad7e2341c646f5e9 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,16 +1,15 @@
 # Jacinto-AI-DevKit (PyTorch)
 
-### Deep Learning Models / Training / Calibration & Quantization - Using PyTorch<br>
-Internal URL: https://bitbucket.itg.ti.com/projects/jacinto-ai-devkit/repos/pytorch-jacinto-ai-devkit<br>
-External URL: https://git.ti.com/jacinto-ai-devkit/pytorch-jacinto-ai-devkit<br>
+Note: 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)
 
-We provide 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**.
+### Deep Learning Models / Training / Calibration & Quantization - Using PyTorch<br>
+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. 
 
-We have added several complexity optimized Deep Learning examples for commonly used vision tasks. We provide training scripts, accuracy, complexity and in some cases, the trained models as well. Our expectation is that these Deep Learning examples and models will find application in a variety of problems, and you will be able to build upon the **building blocks** that we have provided. 
+This code also includes tools for **Post Training Calibration and Trained Quantization (a.k.a 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).
 
-We also have a **Calibration tool for Quantization** that can output an 8-bit Quantization friendly model using a few calibration images - this tool can be used to improve the quantized accuracy and bring it near floating point accuracy. This tools adjusts weights and biases and also collects the ranges of activations to make the model quantization friendly. For more details, please refer to the section on Quantization.
+Our expectation is that these Deep Learning examples, models and tools will find application in a variety of problems, and the users will be able to build upon the **building blocks** that we have provided. 
 
-**Several of these models have been verified to work on [TI's Jacinto Automotive Processors](http://www.ti.com/processors/automotive-processors/tdax-adas-socs/overview.html).** 
+**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).** This code is primarily intended for learning and research. 
 
 ## Installation Instructions
 - These instructions are for installation on **Ubuntu 18.04**. 
@@ -35,19 +34,18 @@ The following examples are currently available. Click on each of the links below
     - [Motion Segmentation](docs/Motion_Segmentation.md)
     - [**Multi Task Estimation**](docs/Multi_Task_Learning.md)
 - Object Detection
-    - [**Object Detection**](docs/Object_Detection.md)
-    - [Object Keypoint Estimation](docs/Keypoint_Estimation.md)
- - [**Quantization**](docs/Quantization.md)<br>
-
-
-We have written down some of the common training and validation commands in the shell scripts (.sh files) provided in the root folder.
+    - Object Detection - coming soon..
+    - Object Keypoint Estimation - coming soon..
+ - Quantization
+     - [**Post Training Calibration For Quantization**](docs/Quantization.md)<br>
+     - [**Quantization Aware Training**](docs/Quantization.md)<br>
 
-## Model Zoo
-Sample models are uploaded in our [modelzoo](./data/modelzoo). Some of our scripts use the pretrained models from this modelzoo.
+Some of the common training and validation commands are provided in shell scripts (.sh files) in the root folder.
 
 ## Additional Information
 For information on other similar devkits, please visit:<br> 
-http://git.ti.com/jacinto-ai-devkit
+- [https://github.com/TexasInstruments/jacinto-ai-devkit](https://github.com/TexasInstruments/jacinto-ai-devkit)<br> AND
+- [https://git.ti.com/jacinto-ai-devkit](https://git.ti.com/jacinto-ai-devkit)<br>
 
 ## Acknowledgements