Skip to content

Commit 92ab59d

Browse files
cencarnamclaireb
authored andcommitted
README: update top-level docs for building and flashing added examples
1 parent 5b23cf5 commit 92ab59d

File tree

1 file changed

+31
-9
lines changed

1 file changed

+31
-9
lines changed

README.md

Lines changed: 31 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,10 @@ To build the project, you will need to download and install the following softwa
6060
# Building the example application
6161

6262
### About the example applications
63-
The [examples](examples) folder includes the SHARC-FX port for the DTLN(Dual-signal Transformation LSTM Network) denoiser application. This example utilizes the ADAU1979 ADC and the ADAU1962A DAC to operate in I2S mode for audio talkthrough that has been leveraged to run the DTLN denoiser in realtime.
63+
The [examples](examples) folder includes the SHARC-FX port for the following applications:
64+
* [DTLN (Dual-signal Transformation LSTM Network) denoiser](examples/denoiser)
65+
* [CNN genre identification](examples/genre_identification)
66+
* [DS-CNN keyword spotting](examples/keyword_spotter)
6467

6568
Building the example application is a two-stage process. First, you will need to build the static library archive (`libTFLM.a`). The generated library archive is then linked and built together with the example application project to create the executable file. To illustrate:
6669

@@ -93,35 +96,54 @@ Next, build the `libTFLM.a` file:
9396
At this point, you should have a `libTFLM.a` library archive located inside the `Debug` or `Release` folder.
9497

9598
Instructions to build and run the examples are found in their respective READMEs.
96-
- [Denoiser Real-time](examples/denoiser_realtime/README.md)
97-
- [Denoiser File I/O](examples/denoiser_fileio/README.md)
98-
99-
We have also included utilities for automated model conversion for the DTLN model. These are available in the [utils](Utils) directory.
100-
- [Automated model conversion for DTLN](Utils/automated-model-conversion-dtln/README.md)
99+
- [Denoiser](examples/denoiser/README.md)
100+
- [Keyword Spotting](examples/keyword_spotter/README.md)
101+
- [Genre Identification](examples/genre_identification/README.md)
101102

103+
We have also included utilities for automated model conversion and flashing. These are available in the [utils](Utils) directory.
104+
- [Automated model conversion for DTLN](Utils/automated-model-conversion/dtln/README.md)
105+
- [Automated model conversion for Genre ID](Utils/automated-model-conversion/genre_identification/README.md)
106+
- [Flashing](Utils/flashing-tools/README.md)
102107

103108
### Option 2: via the Headless build
104109

105-
We also provide a CLI-based build workflow that is equivalent to the IDE-based workflow in the CCES ecosystem. At the monent, the headless interface only supports the building `libTFLM.a` library archive. Support to build the examples and generate the *.dxe executables will be included in future releases.
110+
We also provide a CLI-based build workflow that is equivalent to the IDE-based workflow in the CCES ecosystem. The headless interface supports building the `libTFLM.a` library archive.
106111

107112
To build the library archive for TFLM with the optimized kernels, run make on the top-level directory:
108113
```
109114
make
110115
```
111116

112-
By default, the build script uses `/c/analog/cces` as the CCES search path for the SHARC-FX toolchains and the default target is for the [ADSP-SC835](https://www.analog.com/en/products/adsp-sc835.html). </br> `RELEASE` is the default configuration but you may also select to `DEBUG` configuration mode.
117+
By default, the build script uses `/c/analog/cces` as the search path for the SHARC-FX toolchains and the default target is for the [ADSP-SC835](https://www.analog.com/en/products/adsp-sc835.html). </br> `RELEASE` is the default configuration but you may also select to `DEBUG` configuration mode.
113118

114119
To configure these, run
115120
```
116-
make CCES=</path/to/cces> TARGET=<DEVICE_NAME> CONFIG=<CONFIG_MODE>
121+
make SHARCFX_ROOT=</path/to/cces> DEVICE=<DEVICE_NAME> CONFIG=<CONFIG_MODE>
117122
```
123+
118124
The script will output a `./build/libTFLM.a` library which can be linked to other projects using the `-lTFLM` flag.
119125

120126
Build objects are stored in the `./build` directory. To remove these, run
121127
```
122128
make clean
123129
```
124130

131+
The headless interface also allows building and flashing an example project. To build an example application:
132+
```
133+
cd examples/<example_project>/<example_realtime|fileio>
134+
make
135+
```
136+
137+
To flash to the board with a debugger, run
138+
```
139+
make flash
140+
```
141+
142+
The default debugger is ICE-1000. To configure this with other debugger like the ICE-2000, run
143+
```
144+
make flash DEBUGGER=2000
145+
```
146+
125147
# Getting Help
126148

127149
Please raise a GitHub Issue for support.

0 commit comments

Comments
 (0)