From c0accd8f5107d9ab4e8712ac06d9eb38f5b979a6 Mon Sep 17 00:00:00 2001
From: Maxence Ferrari <maxence.ferrari@lis-lab.fr>
Date: Mon, 10 Jan 2022 09:21:27 +0100
Subject: [PATCH] Add README.md

---
 README.md | 11 +++++++++++
 1 file changed, 11 insertions(+)
 create mode 100644 README.md

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8eda919
--- /dev/null
+++ b/README.md
@@ -0,0 +1,11 @@
+# CARIMAM_DOCC10
+
+Convolutionnal neural networks for click classification.
+
+Call the python script followed by the list of wav files you would like to process, and optionnaly an output filename.
+For example : 
+`python forward_UpDimV2_long.py path/to/file_or_folder --output_path predictions.pkl`
+
+Use `python forward_UpDimV2_long.py -h` to display the help message with all the possible argmuments and their usage.
+
+The required libraries are PIL, torch, torchvision, torchelie, numpy, soundfile, scipy and tqdm
-- 
GitLab