From 7a04a3ac677be7cef819b0ed0da2a80767bb596e Mon Sep 17 00:00:00 2001 From: fedir Date: Sat, 10 Jan 2026 20:49:59 +0100 Subject: [PATCH] updated README --- README.md | 30 +++++++++++++++++++++++++++++- 1 file changed, 29 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index b51bc73..b5045d6 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,31 @@ # caveman -Audio reconstruction model, that "uncompresses" lossy mp3s. \ No newline at end of file +Audio reconstruction model, that "uncompresses" lossy mp3s. + +## Installing dependencies + +There is the pyproject file, so you can use that. + +Or, if you prefer to keep your sanity, use uv: + +``` +uv sync +``` + +## Training + +Adjust the location of your data directories via the variables in the cavemanml.py file. Any compression type is accepted, as long as your audio is 44100kHz. + +``` +uv run cavemanml.py +``` + +Obviously the original dataset (FMA) is not provided with this repo. + +## Inference + +For now, the only inference this code can do, is the example. You can adjust the input and output file in the code, though. Theoretically, the model should take on anything. To use the provided checkpoint: + +``` +uv run cavemanml.py ./checkpoint70.pth +```