search

UCSD-E4E / PyHa

A repo designed to convert audio-based "weak" labels to "strong" intraclip labels. Provides a pipeline to compare automated moment-to-moment labels to human labels. Methods range from DSP based foreground-background separation, cross-correlation based template matching, as well as bird presence sound event detection deep learning models!
Other
16 stars 11 forks source link

[📝] Autogenerate Documentation #184

Closed natmfat closed 1 month ago

natmfat commented 10 months ago

I added pdoc in a GitHub Action to automatically generate documentation when the main branch changes. Here's a preview on my fork.

NOTE: This will require enabling GitHub Pages in settings so the documentation will automatically be deployed (replace the test branch with "main" instead, example of settings shown below).

image

JacobGlennAyers commented 10 months ago

Seems to be missing the first argument in every function - In this example, the local_scores is not formatted the same way as the others image

JacobGlennAyers commented 10 months ago

The returns is also formatted differently

natmfat commented 10 months ago

My bad I forgot to tell it to use Google-style docstrings (made a new commit, looks like this since it'll take a few minutes to build/deploy:) image