Added filter by wordcount function

[Veronika271]

Description

Wrote a method that counts the number of words in a speech sample and then returns True if the number of words falls within a specified range, and False otherwise.

Related Issue(s)

#289

Motivation and Context

Sometimes people talk very little, especially when they are struggling with certain mood disorders. I'm worried that if we don't get a sufficiently long voice sample, it will be hard to draw any conclusions due to small sample size.

How Has This Been Tested?

I tested it locally on a toy example and showed it to Dr. Catania!

[github-actions]

🚀 First Pull Request 🎉

Welcome to Senselab, and thank you for submitting your first pull request! We’re thrilled to have your contribution. Our team will review it as soon as possible. Stay engaged, and let’s make behavioral data analysis even more powerful together!

[ibevers]

@Veronika271 can you add a unit test for this?

[ibevers]

I tested it locally on a toy example and showed it to Dr. Catania!

Nice!:) @Veronika271 feel free to call him Fabio--he prefers that as far as I know:)

[ibevers]

Overall, this looks like a great first addition! There's a few little things to do, but I like it overall🙂🌱

[ibevers]

@Veronika271

senselab/src/tests/audio/tasks/speech_enhancement_test.py

Line 71 in a41ffc0

resampled_mono_audio_sample: Audio, resampled_mono_audio_sample_x2: Audio, speechbrain_model: SpeechBrainModel

In your unit test, you can pass an audio sample like this--we have it configured this way for convenience

[ibevers]

@Veronika271 see all the audio samples you can use here:
src/tests/audio/conftest.py

[ibevers]

Thanks for adding unit tests:)

[ibevers]

@Veronika271 I think this functionality would fit better within the quality_control module now that it exists. Would you mind doing these steps?

• Change base to 276-feature-implement-bioacoustic-quality-control-framework
• Create a metric function that counts the number of words here: src/senselab/audio/tasks/bioacoustic_qc/metrics.py
• Create a check function that determines whether the number of words are in a range here: src/senselab/audio/tasks/bioacoustic_qc/checks.py

[satra]

Closing — stale. Tracked by issue #289 under meta issue #474 (Audio Data Model).