From b001d893d0493145cb74ac60b7b3aab69df42401 Mon Sep 17 00:00:00 2001
From: Nilo Pedrazzini <nilo.pedrazzini@gmail.com>
Date: Thu, 25 Nov 2021 10:41:51 +0000
Subject: [PATCH] add READMEs to empty folders

---
 .gitignore                        | 1 +
 test_data/annotated/README.md     | 2 ++
 test_data/gold/README.md          | 2 ++
 test_data/tobeannotated/README.md | 2 ++
 training_data/new/README.md       | 2 ++
 training_data/past/README.md      | 2 ++
 6 files changed, 11 insertions(+)
 create mode 100644 .gitignore
 create mode 100644 test_data/annotated/README.md
 create mode 100644 test_data/gold/README.md
 create mode 100644 test_data/tobeannotated/README.md
 create mode 100644 training_data/new/README.md
 create mode 100644 training_data/past/README.md

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..e43b0f9
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+.DS_Store
diff --git a/test_data/annotated/README.md b/test_data/annotated/README.md
new file mode 100644
index 0000000..018b8eb
--- /dev/null
+++ b/test_data/annotated/README.md
@@ -0,0 +1,2 @@
+# Annotated texts
+Texts which have been annotated with ./tag.sh or as part of the validation phase of ./train.sh will be added here.
\ No newline at end of file
diff --git a/test_data/gold/README.md b/test_data/gold/README.md
new file mode 100644
index 0000000..90a7bd9
--- /dev/null
+++ b/test_data/gold/README.md
@@ -0,0 +1,2 @@
+# Texts with gold annotation
+Add your texts containing gold annotation here. Files in this folder are used as part of the ./train.sh validation phase.
\ No newline at end of file
diff --git a/test_data/tobeannotated/README.md b/test_data/tobeannotated/README.md
new file mode 100644
index 0000000..44ee240
--- /dev/null
+++ b/test_data/tobeannotated/README.md
@@ -0,0 +1,2 @@
+# New test data
+Here you can add texts you want to annotate through ./tag.sh or as part of the ./train.sh validation stage.
\ No newline at end of file
diff --git a/training_data/new/README.md b/training_data/new/README.md
new file mode 100644
index 0000000..ce42881
--- /dev/null
+++ b/training_data/new/README.md
@@ -0,0 +1,2 @@
+# New training data
+Add your new training (train.conllu) and development (dev.conllu) data in this folder.
\ No newline at end of file
diff --git a/training_data/past/README.md b/training_data/past/README.md
new file mode 100644
index 0000000..7cbeae8
--- /dev/null
+++ b/training_data/past/README.md
@@ -0,0 +1,2 @@
+# Past training data
+Training and development data used to train past models are automatically moved inside this directory after training is finished.
\ No newline at end of file