LAAC-LSCP / ChildProject

Python package for the management of day-long recordings of children.
https://childproject.readthedocs.io
MIT License
13 stars 5 forks source link

note change in behavior validate #304

Closed alecristia closed 2 years ago

alecristia commented 2 years ago

$ child-project validate . --ignore-files --check-annotations usage: child-project [-h] {validate,import-annotations,merge-annotations,intersect-annotations,remove-annotations,rename-annotations,overview,compute-durations,process,sampler,zooniverse,eaf-builder,anonymize,metrics} ... child-project: error: unrecognized arguments: --ignore-files --check-annotations

$ child-project validate -h usage: child-project validate [-h] [--ignore-recordings] [--profile PROFILE] [--annotations ANNOTATIONS [ANNOTATIONS ...]] [--threads THREADS] source

validate the consistency of the dataset returning detailed errors and warnings

positional arguments: source project path

optional arguments: -h, --help show this help message and exit --ignore-recordings ignore missing audio files --profile PROFILE which recording profile to validate --annotations ANNOTATIONS [ANNOTATIONS ...] path to or name of each annotation set(s) to check (e.g. 'vtc' or '/path/to/dataset/annotations/vtc') --threads THREADS amount of threads to run on (only applies to --annotations)

I think --ignore-files --> --ignore-recordings, and we lost --check-annotations, right?

lucasgautheron commented 2 years ago

--ignore-files was changed to --ignore-recordings since #283 and #284 --check-annotations is now --annotations and you need to specify which annotations to check you can find examples in the docs: https://childproject.readthedocs.io/en/latest/tools.html#data-validation

If you find parts of the documentation that are out of date, please let me know:)