You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+31-9Lines changed: 31 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -60,7 +60,10 @@ To build the project, you will need to download and install the following softwa
60
60
# Building the example application
61
61
62
62
### 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:
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:
66
69
@@ -93,35 +96,54 @@ Next, build the `libTFLM.a` file:
93
96
At this point, you should have a `libTFLM.a` library archive located inside the `Debug` or `Release` folder.
94
97
95
98
Instructions to build and run the examples are found in their respective READMEs.
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)
102
107
103
108
### Option 2: via the Headless build
104
109
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.
106
111
107
112
To build the library archive for TFLM with the optimized kernels, run make on the top-level directory:
108
113
```
109
114
make
110
115
```
111
116
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.
113
118
114
119
To configure these, run
115
120
```
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>
117
122
```
123
+
118
124
The script will output a `./build/libTFLM.a` library which can be linked to other projects using the `-lTFLM` flag.
119
125
120
126
Build objects are stored in the `./build` directory. To remove these, run
121
127
```
122
128
make clean
123
129
```
124
130
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
0 commit comments