forked from micropython/micropython
-
Notifications
You must be signed in to change notification settings - Fork 8
Add dc docs #210
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Add dc docs #210
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,70 @@ | ||
| .. _psoc6_mpy_deepcraft_integration: | ||
|
|
||
| MicroPython - DEEPCRAFT™ Integration | ||
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | ||
|
|
||
| `DEEPCRAFT™ <https://www.infineon.com/cms/en/design-support/software/deepcraft-edge-ai-solutions/>`_ is Infineon's comprehensive new Edge AI software & tools offering designed to fastrack edge machine learning | ||
| application development. | ||
|
|
||
| `DEEPCRAFT™ Studio`_ is a development platform for AI on edge devices. It provides unique modeling capabilities | ||
| to make custom edge AI models for PSOC-based hardware. Its integration with MicroPython allows an easy end-to-end | ||
| application development and deployment journey. | ||
|
|
||
| Follow along to build your first edge Machine Learning (ML) application with MicroPython and DEEPCRAFT™ Studio. 🚀 | ||
|
|
||
| Overview | ||
| ========= | ||
| This solution follows a standard edge ML application workflow, consisting of two primary phases: training and inferencing. | ||
| The training phase is efficiently managed within DEEPCRAFT™ Studio. | ||
|
|
||
| The diagrams below provide a detailed overview of the workflows for both phases, highlighting the tools and steps involved, | ||
| from data acquisition to model deployment. | ||
|
|
||
| .. image:: img/training_phase.png | ||
| :width: 1000 | ||
|
|
||
| During the training phase, the edge device executes a MicroPython script that streams raw sensor data to a host machine. A capture server running on the host | ||
| receives this data and stores it as timestamped files. These files are then imported into DEEPCRAFT™ Studio, where they undergo labeling, preprocessing, | ||
| and are used to train a machine learning model tailored to the specific application. With MicroPython integration, the trained model can be effortlessly converted | ||
| into a runtime-loadable format and deployed to the device's filesystem. This streamlined workflow, which supports iterative tuning for optimal accuracy, | ||
| greatly simplifies the model conversion and deployment process. | ||
|
|
||
|
|
||
| .. image:: img/inferencing_phase.png | ||
| :width: 1000 | ||
|
|
||
| After achieving satisfactory accuracy, the model is ready for deployment in the final application. During this phase, a MicroPython script stored on the edge device's filesystem | ||
| manages sensor data acquisition and feeds it to the dynamically loaded model. The pre-trained model processes the input data and generates class probabilities based on the learned patterns. | ||
| These outputs can then be utilized to trigger actions through peripherals (e.g., LEDs, buzzers) or transmitted to external interfaces, such as a web dashboard, for visualization. | ||
|
|
||
| With this streamlined development workflow, let's proceed to build a complete edge ML application step by step. | ||
|
|
||
| Pre-requisites | ||
| ================ | ||
|
|
||
| Ensure the following tools are installed on your system: | ||
|
|
||
| 1. `DEEPCRAFT™ Studio`_ | ||
| 2. `Capture Server cloned in your local <https://bitbucket.org/imagimob/captureserver/src/master/>`_ | ||
|
|
||
| Supported Boards | ||
| ================== | ||
| - `CY8CKIT-062S2-AI <https://www.infineon.com/cms/en/product/evaluation-boards/cy8ckit-062s2-ai/>`_ | ||
|
|
||
| 1. Data Acquisition | ||
| ====================== | ||
|
|
||
| This part is covered in the `data acquisition repository <https://github.com/Infineon/deepcraft-micropython-data-acquisition>`_, which provides | ||
| instructions and examples for data acquisition using MicroPython. | ||
|
|
||
| 2. Model Deployment | ||
| ===================== | ||
|
|
||
| This part is covered in the `model converter repository <https://github.com/Infineon/deepcraft-micropython-converter>`_, which provides instructions | ||
| on how to convert a DEEPCRAFT™ model into a MicroPython-compatible format and deploy it on the PSOC board. | ||
|
|
||
| Example Projects | ||
| ================== | ||
| - `Edge AI-based baby cry detector with Home Assistant integration <https://www.hackster.io/Infineon_Team/ai-baby-cry-detector-with-home-assistant-integration-05576f>`_ | ||
|
|
||
| .. _DEEPCRAFT™ Studio: https://softwaretools.infineon.com/tools/com.ifx.tb.tool.deepcraftstudio | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@ederjc : I thought of the article but this is not depending on the integration explained above. Should this still find a place here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As discussed, we keep it for now and later replce/update with right articles.