Skip to content

Commit

Permalink
docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
JoFrhwld committed Mar 14, 2024
1 parent 030179f commit 159d17d
Show file tree
Hide file tree
Showing 8 changed files with 122 additions and 64 deletions.
5 changes: 5 additions & 0 deletions docs/_quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,11 @@ quartodoc:
children: embedded
- name: CandidateTracks
children: embedded
- title: Outputs
desc: Data outputs
contents:
- processors.outputs.pickle_candidates
- processors.outputs.unpickle_candidates

- title: Smoothers
desc: Smoother
Expand Down
2 changes: 1 addition & 1 deletion docs/objects.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"project": "fasttrackpy", "version": "0.0.9999", "count": 34, "items": [{"name": "fasttrackpy.process_audio_file", "domain": "py", "role": "function", "priority": "1", "uri": "reference/process_audio_file.html#fasttrackpy.process_audio_file", "dispname": "-"}, {"name": "fasttrackpy.patterns.just_audio.process_audio_file", "domain": "py", "role": "function", "priority": "1", "uri": "reference/process_audio_file.html#fasttrackpy.process_audio_file", "dispname": "fasttrackpy.process_audio_file"}, {"name": "fasttrackpy.process_directory", "domain": "py", "role": "function", "priority": "1", "uri": "reference/process_directory.html#fasttrackpy.process_directory", "dispname": "-"}, {"name": "fasttrackpy.patterns.just_audio.process_directory", "domain": "py", "role": "function", "priority": "1", "uri": "reference/process_directory.html#fasttrackpy.process_directory", "dispname": "fasttrackpy.process_directory"}, {"name": "fasttrackpy.process_audio_textgrid", "domain": "py", "role": "function", "priority": "1", "uri": "reference/process_audio_textgrid.html#fasttrackpy.process_audio_textgrid", "dispname": "-"}, {"name": "fasttrackpy.patterns.audio_textgrid.process_audio_textgrid", "domain": "py", "role": "function", "priority": "1", "uri": "reference/process_audio_textgrid.html#fasttrackpy.process_audio_textgrid", "dispname": "fasttrackpy.process_audio_textgrid"}, {"name": "fasttrackpy.process_corpus", "domain": "py", "role": "function", "priority": "1", "uri": "reference/process_corpus.html#fasttrackpy.process_corpus", "dispname": "-"}, {"name": "fasttrackpy.patterns.corpus.process_corpus", "domain": "py", "role": "function", "priority": "1", "uri": "reference/process_corpus.html#fasttrackpy.process_corpus", "dispname": "fasttrackpy.process_corpus"}, {"name": "fasttrackpy.OneTrack.spectrogram", "domain": "py", "role": "function", "priority": "1", "uri": "reference/OneTrack.html#fasttrackpy.OneTrack.spectrogram", "dispname": "-"}, {"name": "fasttrackpy.tracks.OneTrack.spectrogram", "domain": "py", "role": "function", "priority": "1", "uri": "reference/OneTrack.html#fasttrackpy.OneTrack.spectrogram", "dispname": "fasttrackpy.OneTrack.spectrogram"}, {"name": "fasttrackpy.OneTrack.to_df", "domain": "py", "role": "function", "priority": "1", "uri": "reference/OneTrack.html#fasttrackpy.OneTrack.to_df", "dispname": "-"}, {"name": "fasttrackpy.tracks.OneTrack.to_df", "domain": "py", "role": "function", "priority": "1", "uri": "reference/OneTrack.html#fasttrackpy.OneTrack.to_df", "dispname": "fasttrackpy.OneTrack.to_df"}, {"name": "fasttrackpy.OneTrack", "domain": "py", "role": "class", "priority": "1", "uri": "reference/OneTrack.html#fasttrackpy.OneTrack", "dispname": "-"}, {"name": "fasttrackpy.tracks.OneTrack", "domain": "py", "role": "class", "priority": "1", "uri": "reference/OneTrack.html#fasttrackpy.OneTrack", "dispname": "fasttrackpy.OneTrack"}, {"name": "fasttrackpy.CandidateTracks.spectrograms", "domain": "py", "role": "function", "priority": "1", "uri": "reference/CandidateTracks.html#fasttrackpy.CandidateTracks.spectrograms", "dispname": "-"}, {"name": "fasttrackpy.tracks.CandidateTracks.spectrograms", "domain": "py", "role": "function", "priority": "1", "uri": "reference/CandidateTracks.html#fasttrackpy.CandidateTracks.spectrograms", "dispname": "fasttrackpy.CandidateTracks.spectrograms"}, {"name": "fasttrackpy.CandidateTracks.to_df", "domain": "py", "role": "function", "priority": "1", "uri": "reference/CandidateTracks.html#fasttrackpy.CandidateTracks.to_df", "dispname": "-"}, {"name": "fasttrackpy.tracks.CandidateTracks.to_df", "domain": "py", "role": "function", "priority": "1", "uri": "reference/CandidateTracks.html#fasttrackpy.CandidateTracks.to_df", "dispname": "fasttrackpy.CandidateTracks.to_df"}, {"name": "fasttrackpy.CandidateTracks", "domain": "py", "role": "class", "priority": "1", "uri": "reference/CandidateTracks.html#fasttrackpy.CandidateTracks", "dispname": "-"}, {"name": "fasttrackpy.tracks.CandidateTracks", "domain": "py", "role": "class", "priority": "1", "uri": "reference/CandidateTracks.html#fasttrackpy.CandidateTracks", "dispname": "fasttrackpy.CandidateTracks"}, {"name": "fasttrackpy.Smoother.smooth", "domain": "py", "role": "function", "priority": "1", "uri": "reference/Smoother.html#fasttrackpy.Smoother.smooth", "dispname": "-"}, {"name": "fasttrackpy.processors.smoothers.Smoother.smooth", "domain": "py", "role": "function", "priority": "1", "uri": "reference/Smoother.html#fasttrackpy.Smoother.smooth", "dispname": "fasttrackpy.Smoother.smooth"}, {"name": "fasttrackpy.Smoother", "domain": "py", "role": "class", "priority": "1", "uri": "reference/Smoother.html#fasttrackpy.Smoother", "dispname": "-"}, {"name": "fasttrackpy.processors.smoothers.Smoother", "domain": "py", "role": "class", "priority": "1", "uri": "reference/Smoother.html#fasttrackpy.Smoother", "dispname": "fasttrackpy.Smoother"}, {"name": "fasttrackpy.processors.smoothers.Smoothed", "domain": "py", "role": "class", "priority": "1", "uri": "reference/processors.smoothers.Smoothed.html#fasttrackpy.processors.smoothers.Smoothed", "dispname": "-"}, {"name": "fasttrackpy.processors.smoothers.dct_smooth", "domain": "py", "role": "function", "priority": "1", "uri": "reference/processors.smoothers.dct_smooth.html#fasttrackpy.processors.smoothers.dct_smooth", "dispname": "-"}, {"name": "fasttrackpy.processors.smoothers.dct_smooth_regression", "domain": "py", "role": "function", "priority": "1", "uri": "reference/processors.smoothers.dct_smooth_regression.html#fasttrackpy.processors.smoothers.dct_smooth_regression", "dispname": "-"}, {"name": "fasttrackpy.Loss", "domain": "py", "role": "class", "priority": "1", "uri": "reference/Loss.html#fasttrackpy.Loss", "dispname": "-"}, {"name": "fasttrackpy.processors.losses.Loss", "domain": "py", "role": "class", "priority": "1", "uri": "reference/Loss.html#fasttrackpy.Loss", "dispname": "fasttrackpy.Loss"}, {"name": "fasttrackpy.processors.losses.lmse", "domain": "py", "role": "function", "priority": "1", "uri": "reference/processors.losses.lmse.html#fasttrackpy.processors.losses.lmse", "dispname": "-"}, {"name": "fasttrackpy.processors.losses.mse", "domain": "py", "role": "function", "priority": "1", "uri": "reference/processors.losses.mse.html#fasttrackpy.processors.losses.mse", "dispname": "-"}, {"name": "fasttrackpy.Agg", "domain": "py", "role": "class", "priority": "1", "uri": "reference/Agg.html#fasttrackpy.Agg", "dispname": "-"}, {"name": "fasttrackpy.processors.aggs.Agg", "domain": "py", "role": "class", "priority": "1", "uri": "reference/Agg.html#fasttrackpy.Agg", "dispname": "fasttrackpy.Agg"}, {"name": "fasttrackpy.processors.aggs.agg_sum", "domain": "py", "role": "function", "priority": "1", "uri": "reference/processors.aggs.agg_sum.html#fasttrackpy.processors.aggs.agg_sum", "dispname": "-"}]}
{"project": "fasttrackpy", "version": "0.0.9999", "count": 36, "items": [{"name": "fasttrackpy.process_audio_file", "domain": "py", "role": "function", "priority": "1", "uri": "reference/process_audio_file.html#fasttrackpy.process_audio_file", "dispname": "-"}, {"name": "fasttrackpy.patterns.just_audio.process_audio_file", "domain": "py", "role": "function", "priority": "1", "uri": "reference/process_audio_file.html#fasttrackpy.process_audio_file", "dispname": "fasttrackpy.process_audio_file"}, {"name": "fasttrackpy.process_directory", "domain": "py", "role": "function", "priority": "1", "uri": "reference/process_directory.html#fasttrackpy.process_directory", "dispname": "-"}, {"name": "fasttrackpy.patterns.just_audio.process_directory", "domain": "py", "role": "function", "priority": "1", "uri": "reference/process_directory.html#fasttrackpy.process_directory", "dispname": "fasttrackpy.process_directory"}, {"name": "fasttrackpy.process_audio_textgrid", "domain": "py", "role": "function", "priority": "1", "uri": "reference/process_audio_textgrid.html#fasttrackpy.process_audio_textgrid", "dispname": "-"}, {"name": "fasttrackpy.patterns.audio_textgrid.process_audio_textgrid", "domain": "py", "role": "function", "priority": "1", "uri": "reference/process_audio_textgrid.html#fasttrackpy.process_audio_textgrid", "dispname": "fasttrackpy.process_audio_textgrid"}, {"name": "fasttrackpy.process_corpus", "domain": "py", "role": "function", "priority": "1", "uri": "reference/process_corpus.html#fasttrackpy.process_corpus", "dispname": "-"}, {"name": "fasttrackpy.patterns.corpus.process_corpus", "domain": "py", "role": "function", "priority": "1", "uri": "reference/process_corpus.html#fasttrackpy.process_corpus", "dispname": "fasttrackpy.process_corpus"}, {"name": "fasttrackpy.OneTrack.spectrogram", "domain": "py", "role": "function", "priority": "1", "uri": "reference/OneTrack.html#fasttrackpy.OneTrack.spectrogram", "dispname": "-"}, {"name": "fasttrackpy.tracks.OneTrack.spectrogram", "domain": "py", "role": "function", "priority": "1", "uri": "reference/OneTrack.html#fasttrackpy.OneTrack.spectrogram", "dispname": "fasttrackpy.OneTrack.spectrogram"}, {"name": "fasttrackpy.OneTrack.to_df", "domain": "py", "role": "function", "priority": "1", "uri": "reference/OneTrack.html#fasttrackpy.OneTrack.to_df", "dispname": "-"}, {"name": "fasttrackpy.tracks.OneTrack.to_df", "domain": "py", "role": "function", "priority": "1", "uri": "reference/OneTrack.html#fasttrackpy.OneTrack.to_df", "dispname": "fasttrackpy.OneTrack.to_df"}, {"name": "fasttrackpy.OneTrack", "domain": "py", "role": "class", "priority": "1", "uri": "reference/OneTrack.html#fasttrackpy.OneTrack", "dispname": "-"}, {"name": "fasttrackpy.tracks.OneTrack", "domain": "py", "role": "class", "priority": "1", "uri": "reference/OneTrack.html#fasttrackpy.OneTrack", "dispname": "fasttrackpy.OneTrack"}, {"name": "fasttrackpy.CandidateTracks.spectrograms", "domain": "py", "role": "function", "priority": "1", "uri": "reference/CandidateTracks.html#fasttrackpy.CandidateTracks.spectrograms", "dispname": "-"}, {"name": "fasttrackpy.tracks.CandidateTracks.spectrograms", "domain": "py", "role": "function", "priority": "1", "uri": "reference/CandidateTracks.html#fasttrackpy.CandidateTracks.spectrograms", "dispname": "fasttrackpy.CandidateTracks.spectrograms"}, {"name": "fasttrackpy.CandidateTracks.to_df", "domain": "py", "role": "function", "priority": "1", "uri": "reference/CandidateTracks.html#fasttrackpy.CandidateTracks.to_df", "dispname": "-"}, {"name": "fasttrackpy.tracks.CandidateTracks.to_df", "domain": "py", "role": "function", "priority": "1", "uri": "reference/CandidateTracks.html#fasttrackpy.CandidateTracks.to_df", "dispname": "fasttrackpy.CandidateTracks.to_df"}, {"name": "fasttrackpy.CandidateTracks", "domain": "py", "role": "class", "priority": "1", "uri": "reference/CandidateTracks.html#fasttrackpy.CandidateTracks", "dispname": "-"}, {"name": "fasttrackpy.tracks.CandidateTracks", "domain": "py", "role": "class", "priority": "1", "uri": "reference/CandidateTracks.html#fasttrackpy.CandidateTracks", "dispname": "fasttrackpy.CandidateTracks"}, {"name": "fasttrackpy.processors.outputs.pickle_candidates", "domain": "py", "role": "function", "priority": "1", "uri": "reference/processors.outputs.pickle_candidates.html#fasttrackpy.processors.outputs.pickle_candidates", "dispname": "-"}, {"name": "fasttrackpy.processors.outputs.unpickle_candidates", "domain": "py", "role": "function", "priority": "1", "uri": "reference/processors.outputs.unpickle_candidates.html#fasttrackpy.processors.outputs.unpickle_candidates", "dispname": "-"}, {"name": "fasttrackpy.Smoother.smooth", "domain": "py", "role": "function", "priority": "1", "uri": "reference/Smoother.html#fasttrackpy.Smoother.smooth", "dispname": "-"}, {"name": "fasttrackpy.processors.smoothers.Smoother.smooth", "domain": "py", "role": "function", "priority": "1", "uri": "reference/Smoother.html#fasttrackpy.Smoother.smooth", "dispname": "fasttrackpy.Smoother.smooth"}, {"name": "fasttrackpy.Smoother", "domain": "py", "role": "class", "priority": "1", "uri": "reference/Smoother.html#fasttrackpy.Smoother", "dispname": "-"}, {"name": "fasttrackpy.processors.smoothers.Smoother", "domain": "py", "role": "class", "priority": "1", "uri": "reference/Smoother.html#fasttrackpy.Smoother", "dispname": "fasttrackpy.Smoother"}, {"name": "fasttrackpy.processors.smoothers.Smoothed", "domain": "py", "role": "class", "priority": "1", "uri": "reference/processors.smoothers.Smoothed.html#fasttrackpy.processors.smoothers.Smoothed", "dispname": "-"}, {"name": "fasttrackpy.processors.smoothers.dct_smooth", "domain": "py", "role": "function", "priority": "1", "uri": "reference/processors.smoothers.dct_smooth.html#fasttrackpy.processors.smoothers.dct_smooth", "dispname": "-"}, {"name": "fasttrackpy.processors.smoothers.dct_smooth_regression", "domain": "py", "role": "function", "priority": "1", "uri": "reference/processors.smoothers.dct_smooth_regression.html#fasttrackpy.processors.smoothers.dct_smooth_regression", "dispname": "-"}, {"name": "fasttrackpy.Loss", "domain": "py", "role": "class", "priority": "1", "uri": "reference/Loss.html#fasttrackpy.Loss", "dispname": "-"}, {"name": "fasttrackpy.processors.losses.Loss", "domain": "py", "role": "class", "priority": "1", "uri": "reference/Loss.html#fasttrackpy.Loss", "dispname": "fasttrackpy.Loss"}, {"name": "fasttrackpy.processors.losses.lmse", "domain": "py", "role": "function", "priority": "1", "uri": "reference/processors.losses.lmse.html#fasttrackpy.processors.losses.lmse", "dispname": "-"}, {"name": "fasttrackpy.processors.losses.mse", "domain": "py", "role": "function", "priority": "1", "uri": "reference/processors.losses.mse.html#fasttrackpy.processors.losses.mse", "dispname": "-"}, {"name": "fasttrackpy.Agg", "domain": "py", "role": "class", "priority": "1", "uri": "reference/Agg.html#fasttrackpy.Agg", "dispname": "-"}, {"name": "fasttrackpy.processors.aggs.Agg", "domain": "py", "role": "class", "priority": "1", "uri": "reference/Agg.html#fasttrackpy.Agg", "dispname": "fasttrackpy.Agg"}, {"name": "fasttrackpy.processors.aggs.agg_sum", "domain": "py", "role": "function", "priority": "1", "uri": "reference/processors.aggs.agg_sum.html#fasttrackpy.processors.aggs.agg_sum", "dispname": "-"}]}
Loading

0 comments on commit 159d17d

Please sign in to comment.