Feature/gtcrn micro build1

.gitignore

@@ -190,6 +190,7 @@ cython_debug/
 
 # Ruff stuff:
 .ruff_cache/
+.ruff_cache
 
 # PyPI configuration file
 .pypirc
@@ -206,7 +207,9 @@ marimo/_static/
 marimo/_lsp/
 __marimo__/
 
+# ruff?
+
 # dataset
-python/data/
-python/gtcrn_micro/data/
-python/gtcrn_micro/models/gtcrn/
+/data/
+/gtcrn_micro/data/
+/gtcrn_micro/models/gtcrn/

README.md

@@ -1,4 +1,4 @@
-# SERTime: *Speech Enhancement in Real Time* 
+# GTCRN-Micro: *Microcontroller Speech Enhancement* 
 <div align="center">
 
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
@@ -8,11 +8,19 @@
 
 
 
-
 </div>
 
 ## Roadmap / to-dos 
 
 Overall project roadmap can be found: [docs/plan.md](docs/plan.md)
 
 List of to-dos can be found: [docs/TODO.md](docs/TODO.md)
+
+## Acknowledgements
+- - -
+
+###### 1. The original model this is based off of is [GTCRN](https://github.com/Xiaobin-Rong/gtcrn), as well as a notable amount of the setup to train and change the model was based off of the same authors project [SEtrain](https://github.com/Xiaobin-Rong/SEtrain/tree/plus). They have some seriously impressive SE research! Please check out their research and throw some of their work a star!
+###### 2. The project also requires moving from **PyTorch $\rightarrow$ ONNX $\rightarrow$ .tflite** to run inference on a microcontroller. None of this could have been possible without the direct help and work of [PINTO0309](https://github.com/PINTO0309) & their awesome project [onnx2tf](https://github.com/PINTO0309/onnx2tf). I highly recommend you check out their work if you are reading this and want to do a similar project. Please consider throwing some of their work a star!
+- - - 
+
+*This project would not have been possible without their efforts. Please consider giving them a star first before this project's!*