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.

Sign up for GitHub

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

Jump to bottom

DOC: add usage section #46

Merged
merged 16 commits into from
Jun 10, 2022
Merged

DOC: add usage section #46

merged 16 commits into from
Jun 10, 2022

Conversation

hagenw
Copy link
Member

@hagenw hagenw commented Jun 9, 2022

Closes #5.

This adds a first basic usage section to the documentation, covering:

  • using audinterface.Process
  • using audinterface.Feature
  • building a feature extraction object with audinterface.Feature and audobject.Object

Building the documentation will fail as I get the following warning due to storing and loading the feature extraction object:

WARNING: Cell printed to stderr:
/home/audeering.local/hwierstorf/.envs/audinterface/lib/python3.8/site-packages/audobject/core/utils.py:51: RuntimeWarning: Could not determine a version for module '__main__'.
  warnings.warn(

Any idea how to avoid this?

@hagenw hagenw requested a review from frankenjoe June 9, 2022 08:32
@frankenjoe
Copy link
Collaborator

Any idea how to avoid this?

did you try to set __version__ = '1.0.0' at the top the file?

@hagenw
Copy link
Member Author

hagenw commented Jun 9, 2022

Any idea how to avoid this?

did you try to set __version__ = '1.0.0' at the top the file?

Thanks, this works indeed.

hagenw
hagenw commented Jun 9, 2022
View reviewed changes
docs/usage.rst Outdated Show resolved Hide resolved
frankenjoe
frankenjoe reviewed Jun 9, 2022
View reviewed changes
docs/usage.rst Outdated Show resolved Hide resolved
docs/usage.rst Outdated Show resolved Hide resolved
docs/usage.rst Outdated Show resolved Hide resolved
docs/usage.rst Outdated Show resolved Hide resolved
docs/usage.rst Outdated Show resolved Hide resolved
docs/usage.rst Outdated Show resolved Hide resolved
@frankenjoe
Copy link
Collaborator

Good to see we will finally have a usage section!

hagenw and others added 2 commits June 9, 2022 15:19
@codecov
Copy link

codecov bot commented Jun 9, 2022 •
edited
Loading

Codecov Report

Merging #46 (379f7fa) into master (a21c2f0) will not change coverage.
The diff coverage is n/a.

Impacted Files Coverage Δ
audinterface/core/feature.py 100.0% <0.0%> (ø)
audinterface/core/process.py 100.0% <0.0%> (ø)

@hagenw
Copy link
Member Author

hagenw commented Jun 9, 2022

At the moment every subsection starts with "Create a"

image

should I maybe change to

image

@frankenjoe
Copy link
Collaborator

Should we also add an example for Segment?

frankenjoe
frankenjoe reviewed Jun 9, 2022
View reviewed changes
docs/usage.rst Outdated Show resolved Hide resolved
@hagenw
Copy link
Member Author

hagenw commented Jun 10, 2022

Should we also add an example for Segment?

I added one, but it was not so easy to find a processing function that returns segments.
For now I ended up using https://auditok.readthedocs.io/

@hagenw
Copy link
Member Author

hagenw commented Jun 10, 2022

At the moment every subsection starts with "Create a"

image

should I maybe change to

image

I adjusted the headings accordingly, and also changed the last word always to "interface"

@frankenjoe
Copy link
Collaborator

For now I ended up using https://auditok.readthedocs.io/

Interesting, they even offer real-time detection. Could this also be a candidate benchmark against?

@hagenw
Copy link
Member Author

hagenw commented Jun 10, 2022

For now I ended up using https://auditok.readthedocs.io/

Interesting, they even offer real-time detection. Could this also be a candidate benchmark against?

Maybe, but at least according to this it performs not as good as others: wiseman/py-webrtcvad#68

frankenjoe
frankenjoe reviewed Jun 10, 2022
View reviewed changes
docs/usage.rst Outdated Show resolved Hide resolved
frankenjoe
frankenjoe reviewed Jun 10, 2022
View reviewed changes
docs/usage.rst Outdated Show resolved Hide resolved
hagenw and others added 2 commits June 10, 2022 11:12
@hagenw @frankenjoe
Update docs/usage.rst
1a87cbd 
Co-authored-by: Johannes Wagner <[email protected]>
@hagenw @frankenjoe
Update docs/usage.rst
df59457 
Co-authored-by: Johannes Wagner <[email protected]>
@frankenjoe frankenjoe merged commit de8955b into master Jun 10, 2022
@frankenjoe frankenjoe deleted the add-usage branch June 10, 2022 10:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@frankenjoe frankenjoe frankenjoe left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add usage section to documentation
2 participants
@hagenw @frankenjoe