audeering / audbcards

Data cards for audio datasets
https://audeering.github.io/audbcards/
Other
0 stars 0 forks source link

Add config option to sphinx extension to blacklist datasets from showing example on the datacard #88

Open hagenw opened 5 months ago

hagenw commented 5 months ago

At the moment, you can configure per TOC entry if audio examples should be shown on a datacard. In addition, they are only shown if a dataset contains a file that has at least one file with a duration of >0.5 s and <300s:

https://github.com/audeering/audbcards/blob/d2510eeb4784de55a8f52f6a943a6abce71b5a6a/audbcards/core/datacard.py#L98-L100

But you might still have the problem, that you have datasets that should not be accessibly by all users that can view a datacard. For those it would be good to disable showing an audio example. Another reason might be if all media files are stored in a single (or only a few) archives, as then the whole dataset needs to be downloaded in audb cache just to get a single media example.

To solve this, I would propose to add an config option, that a user can set inside docs/dong.py, e.g. audbcard_datasets_to_exclude_example.