Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rebrand demo script #41

Closed
juanmc2005 opened this issue May 4, 2022 · 1 comment
Closed

Rebrand demo script #41

juanmc2005 opened this issue May 4, 2022 · 1 comment
Labels
API Improvements to the API
Milestone

Comments

@juanmc2005
Copy link
Owner

Problem

The demo script is useful not only as a demo but also as the default way to quickly run the pipeline and see how it behaves under different scenarios. I feel like it's wrong to call it a "demo".

Idea

Change the name from "demo" to "stream", which also reads more clearly:

python -m diart.stream microphone
python -m diart.stream some_file.wav

It would also be useful to improve the argument documentation, since some information is missing, like default values.

@juanmc2005 juanmc2005 added the documentation Improvements or additions to documentation label May 4, 2022
@juanmc2005 juanmc2005 added this to the Version 0.3 milestone May 4, 2022
@juanmc2005 juanmc2005 added API Improvements to the API and removed documentation Improvements or additions to documentation labels May 8, 2022
@juanmc2005
Copy link
Owner Author

Implemented in PR #47

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API Improvements to the API
Projects
None yet
Development

No branches or pull requests

1 participant