فهرست منبع

Updated instructions

William N. Havard 1 سال پیش
والد
کامیت
8d55ce28a1
1فایلهای تغییر یافته به همراه25 افزوده شده و 5 حذف شده
  1. 25 5
      README.md

+ 25 - 5
README.md

@@ -92,8 +92,8 @@ Note that the annotation files should have **unique names** (e.g. like the acous
 **(5)** Save the data set and push the new annotations to GIN
 
 ```bash
-datalad save recordings -m "Imported new recordings for date ${today}"
-datalad save annotations/*/raw -m "Imported raw annotations for date ${today}"
+datalad save recordings -m "Added new recordings for date ${today}"
+datalad save annotations/*/raw -m "Added raw annotations for date ${today}"
 datalad push --to origin
 ```
 
@@ -123,6 +123,15 @@ This script can also take the additional (optional) parameter `--recording`. Whe
 
 You may also use the option `--recordings-from-annotation-file` (incompatible with the previous one) so as to only import the annotations contained in `--annotation-file` for the recordings that also appear in the annotation file `--recordings-from-annotation-file` (i.e. you filter the annotation of `--annotation-file` with the recordings of `--recordings-from-annotation-file`)
 
+You may now save and push. **Do not forget to unlock the `metadata` directory afterwards!**
+
+```bash
+datalad save annotations/*/converted -m "Converted RAW annotations for date ${today}"
+datalad save metadata -m "Imported RAW annotations for date ${today}"
+datalad push --to origin
+datalad unlock metadata
+```
+
 **(8)** Compute the conversational annotations using the following command:
 
 ```bash
@@ -138,6 +147,8 @@ python -u scripts/URUMETRICS-CODE/import_data/import_annotations.py --annotation
 ```
 The name of `--annotations-file` is the name of the VTC file prefixed by `CONVERSATIONS_`.
 
+⚠️! You may need to import more than one file. Indeed, annotations are computed for all the files that are missing this type of annotation. Hence, more than one output file may be generated if annotations were generated for files imported before.
+
 **(10)** Extract the acoustic annotations using the following command 
 ```bash
 python scripts/URUMETRICS-CODE/compute_annotations/compute_derived_annotations.py --annotation-type ACOUSTIC --save-path annotations/acoustic/raw/ --target-sr 16000
@@ -153,6 +164,18 @@ python -u scripts/URUMETRICS-CODE/import_data/import_annotations.py --annotation
 
 as for conversational annotations, the name of `--annotations-file` is the name of the VTC file prefixed by `ACOUSTIC_`.
 
+⚠️! You may need to import more than one file. Indeed, annotations are computed for all the files that are missing this type of annotation. Hence, more than one output file may be generated if annotations were generated for files imported before.
+
+You may now save and push. **Do not forget to unlock the `metadata` directory afterwards!**
+
+```bash
+datalad save annotations/*/raw -m "Imported DERIVED RAW annotations for date ${today}"
+datalad save annotations/*/converted -m "Convected DERIVED annotations for date ${today}"
+datalad save metadata -m "Imported DERIVED CONVERTED annotations for date ${today}"
+datalad unlock metadata
+```
+
+
 **(11)** Run the following command to compute ACLEW metrics as well as the additional metrics defined in `compute_metrics/metrics_functions.py`:
 
 ```bash
@@ -178,9 +201,6 @@ The file will contain the messages that correspond to each new audio file. The d
 **(13)** Save the data set and push everything to GIN
 
 ```bash
-datalad save annotations/*/raw -m "Imported derived raw annotations for date ${today}"
-datalad save annotations/*/converted -m "Converted annotations for date ${today}"
-datalad save metadata -m "Updated metadata for date ${today}"
 datalad save extra/metrics -m "Computed new metrics for date ${today}"
 datalad save extra/messages/generated -m "Message generated for date ${today}"
 datalad save .