Skip to content

Add FrameGenerator docstring (#1040) #1420

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

Open
awagenknecht wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Add FrameGenerator docstring (#1040) #1420

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c9f239a
Test docstring add with setattr
awagenknecht May 30, 2024
a9c8ea8
Set FrameGenerator docstring
awagenknecht May 30, 2024
d274307
Minor change to FrameGenerator docstring
awagenknecht May 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions src/python/essentia/algorithms.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,5 +138,15 @@ def frame_times(self, sampleRate):
times.append((start + self.hopSize * i) / sampleRate)
return times

# Copy the docstring from FrameCutter and modify for FrameGenerator
docstr = default_fc.__doc__
docstr = docstr.replace('FrameCutter', 'FrameGenerator')
# change input name for consistency with class definition
docstr = docstr.replace('Inputs:\n\n [vector_real] signal', 'Inputs:\n\n [vector_real] audio')
docstr = docstr.replace('Outputs:\n\n [vector_real] frame - the frame to write to',
'Outputs:\n\n An iterator that returns each frame [vector_real] of the input audio.')
docstr = docstr[0:docstr.find('Description:')]
docstr += ('Description:\n\n ' + FrameGenerator.__struct__['description'])
setattr(FrameGenerator, '__doc__', docstr)

setattr(essentia, 'FrameGenerator', FrameGenerator)