juanmc2005 / diart

A python package to build AI-powered real-time audio applications
https://diart.readthedocs.io
MIT License
1.1k stars 90 forks source link

[joss] Tests? #156

Closed sneakers-the-rat closed 6 months ago

sneakers-the-rat commented 1 year ago

Hey! Sorry for the long delay. just started a new job and things have been hectic.

Orienting myself to the package, and I can't seem to find any tests? JOSS doesn't have a minimum test coverage requirement or anything like that, but it does ask that essential functionality is tested, and I have interpreted that in the past as meaning unit tests that cover most of the major operations described in the docs and the paper.

I'll tag all my issues from the review with [joss] and also link back to the review so we can track them from there

Part of: https://github.com/openjournals/joss-reviews/issues/5266

juanmc2005 commented 1 year ago

Hi @sneakers-the-rat ! Thanks for your feedback! I've been wanting to add unit tests for some time (#94). I will prioritize it so they are implemented for the main features of the library.

Otherwise, the core operations of the library can also be verified using the CLI interface: diart.stream for the microphone and individual files, and diart.benchmark to reproduce the performance that we claim (e.g. on the AMI dataset).

sneakers-the-rat commented 1 year ago

I'd be happy to make a pull request adding some tests as examples, if you haven't written them before :)

juanmc2005 commented 1 year ago

That would be awesome, thank you!

sneakers-the-rat commented 1 year ago

Here's an example test for the config: https://github.com/sneakers-the-rat/diart/commit/b1a0ccaa35f8b36aa30f978a4bcb16db69652a42

after installing with [tests], one can run pytest from the repo root to run the tests. Gave an example of using test fixtures for random value init to test that the inputs arent being ignored and defaults substituted

sneakers-the-rat commented 1 year ago

I offered to help with how to write tests! So am happy to answer questions/give examples here :)

juanmc2005 commented 6 months ago

Test PR #237 has been merged and will be included in the next release (v0.10)