From 05a28ca3e2dbc897011daf831976dd53d31c8154 Mon Sep 17 00:00:00 2001 From: Liyux Date: Wed, 14 May 2025 15:36:31 -0400 Subject: [PATCH] Add ReadME --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..604eb50 --- /dev/null +++ b/README.md @@ -0,0 +1,23 @@ +# RIA Hub Technical Demo + +This repository demonstrates a full ML pipeline via Gitea Actions: + +- **Recordings** + A collection of raw `.npy` radio recordings stored via Git LFS. + +- **Workflows** + A CI pipeline that automatically: + 1. Builds a labeled dataset from raw recordings + 2. Trains a model on that dataset + 3. Optimizes the model and packages an inference application + +- **Scripts** + - `scripts/build_dataset.sh` + Reads through `recordings/`, applies preprocessing, and outputs training `.npz` or `.csv` files into `data/`. + - `scripts/train_model.sh` + Consumes `data/`, trains a PyTorch model, and writes checkpoints to `checkpoints/`. + - `scripts/build_app.sh` + Takes the best checkpoint and builds a small inference CLI or server in `dist/`. + + + \ No newline at end of file