Skip to content

Conversation

@tedmoore
Copy link
Member

If anyone has a really keen maskingMode = 2 example that'd be useful!

@tedmoore tedmoore self-assigned this Feb 17, 2022
@tremblap
Copy link
Member

I thought the drums example was sounding fun, no? it was kind of splitting the reverb from the pitch. I can try to make it again with better coefficients

Copy link
Member

@tremblap tremblap left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

'set to 2 (inter-dependant thresholds). See below.' this is clumsy english. maybe just 'see below in the example section' ? but that creates a problem for the pd and max document using the same text so maybe we need an explanation in the text part too.

otherwise it is good, if a little verbose - there will be a clash of culture between the Max style of @jamesb93 when it comes to translating I think.

finally, there is an error: maskmode 2 is binary of sort, definitely not a soft mask for real with continuous values. We can look at the code together but I think we should find a way to explain it clearer how the 2 binary masks fight each other and generate a residual in the conflicting zones.

@tedmoore
Copy link
Member Author

tedmoore commented Mar 24, 2022

@tremblap

finally, there is an error: maskmode 2 is binary of sort, definitely not a soft mask for real with continuous values.

This is what the RST said before I arrived to it:

Inter-dependent mode - Thresholds can be varied independently, but are coupled in effect. Binary masks are made for each of the harmonic and percussive components, and the masks are converted to soft at the end so that everything null sums even if the params are independent, that is what makes it harder to control. These aren't guranteed to cover the whole sound; in this case the 'leftovers' will placed into a third buffer.

It looks to me like they are turned into soft masks at the end:

https://github.com/flucoma/flucoma-core/blob/cdbe03c292dbf220dbc46c3c41aedc60451fe9cb/include/algorithms/public/HPSS.hpp#L127

@tremblap
Copy link
Member

tremblap commented Mar 24, 2022

this is interesting because for me it is binary. let me explain:

  • in the classic, a bin in time can be any ratio of P/H (line 103)
  • in the couped, a bin can either be P or H (line 109-113) with a threshold of truth
  • in the final mode, which was an odd addition after my many hours of playing with the python prototype, we make binary thresholds and inclusion, then we normalise their sum. so it has a binary mask sound, just scaled - a bin can be assigned binarily to P (vs res) and H (vs res) and then will removed from res (line 125-126 cannot go back to true as it is multiplying 0) so the truth table at that state is that there are 4 values possible
    • P1 H0 R0
    • P0 H1 R0
    • P1 H1 R0
    • P0 H0 R1

and the normalisation (line 127-128) scales the 3rd case to match - so that is why it sounds binary as there are only 3 values for each bin's magnitude (0 0.5 1)

calling that a softmask is pushing it a little especially as it doesn't match the phenomenology of what we actually hear...

@tedmoore
Copy link
Member Author

calling that a softmask is pushing it a little especially as it doesn't match the phenomenology of what we actually hear...

What would you like for it to be called?

@tremblap
Copy link
Member

it is a ternary mask, but that is ugly :)

@tedmoore
Copy link
Member Author

How about:

Alongside the harmonic and percussive components, a third component containing "residual" is returned. First, binary masks are made separately for the harmonic and percussive components using different thresholds (set with the respective ``harmThresh-`` and ``percThresh-`` parameters below). Because these masks aren't guaranteed to represent the entire spectrogram, any residual energy is considered as a third output. The independently created binary masks are converted to soft masks at the end of the process so that everything null sums.

I still think soft mask is the right description. Isn't a binary mask binary because it only has two states? It's not a binary mask be cause we have two of them. The masks in this output could be values between 0.0-1.0. So they're soft, even if just not as smoothly continuous as in mode 0?

@tremblap
Copy link
Member

@weefuzzy what do you think? it sounds binary, it has 3 states... how could we phrase it to acknowledge it has veryvery few possible states ?

@tedmoore tedmoore added this to the beta7 milestone May 10, 2022
@tedmoore tedmoore merged commit 1993e87 into dev May 25, 2022
jamesb93 pushed a commit that referenced this pull request Jun 14, 2022
* mfcc rst and sc help file

* mfcc sc examples

* mfcc output

* mfcc helpfile readability

* BufMFCC udpates

* update bufonsetslice docs slightly (#87)

* fix audio transport segmentation of discussion and desc

* fix audio transport segmentation of discussion and desc (#88)

* add missing see alsos

* optional args: add to C++ wrapper

* ParamDump and python: add choices param type

* Json driver (#35)

* Make jinja rendering conditional on driver having a template

* minimal driver for raw JSON output

* cmake target for raw JSON

* fix cmake output directory

* add command line option for raw

* remove spurious item from raw driver

* add back changes that dealt with conditional template rendering

* add a github action for creating a basic API on actions

Co-authored-by: James Bradbury <[email protected]>

* Update json_api.yml

* Update json_api.yml

* Update json_api.yml

* change name of raw output to api.json

* Update json_api.yml

* remove indentation on api

* typo in UMAP

* [Docs] OnsetSlice and BufOnsetSlice (#91)

* update bufonsetslice text

* onsetslice update

* ted's changes

* copy changes to bufonsetslice also

* revamp MelBands and BufMelBands RST, update SC example code

* *melbands description

* added a hyphen

* pitch and buf pitch RST

* added link to the learn page

* edited normalize description

* pitch sc help files

* BufFlatten RST and SC examples

* buf thresh

* sc help file

* typo in fluid pitch sc example code

* bufthresh rst

* typo

* james' feedback

* add .ds_store to gitignore

* pa feedback

* pa feedback

* pa feedback

* PA feedback

* [Docs] Update Normalize Docs (#76)

* update normalize entry

* update description

* pa's requests

Co-authored-by: James Bradbury <[email protected]>

* [Docs] Slicer Feature Objects (#101)

* add skeleton of bufnoveltyfeature

* caveat novelty feature

* add onset feature

* remove space

* add bufampfeature

* realtime amp feature

* update output of AmpFeature

* clean up the language

* caveats for bufonset feature

* add onset feature

* Add JSON generators for Slicers' feature counterparts

* rt noveltyfeature

* fix various errors

* robots in disguise

* change feature -> algorithm

* cleanup noveltyfeature

* make noveltyfeature more consistent

* remove superfluous spaces

* fix description

* fix reference to buffer version in rt object

* add padding

* sc example code for slicer-features

Co-authored-by: weefuzzy <[email protected]>
Co-authored-by: Ted Moore <[email protected]>

* changing preset and interface for noveltyslice examples

* Add argument handlers for const DataSet / LabelSet

* Max/PD: Generate docs for control-in objects (input size and autosize)

* Enhance/max params (#104)

* CMake: Centralise C++ version and set to 17

* Wrapper: Handle new LongRuntimeMax parameter type

* Doc generators: Handle new LongRuntimeMax type + rules for args in Max/PD

* Add a `striprst` jinja filter for removing rst markup in templates (#107)

Such as Max object level description tags

* UMAP cmake reference to python sorted

* typo

* Wrapper and doc-gen update for new `maxFFTSize`

* Buf stats (#103)

* BufStats RST

* BufStats ⚠️

* bufstats supercollider examples

* re-organized descriptions

* added table back in

* typo

* added url

* bufcompose update (#95)

* PCA inverseTransformPoint (#97)

* PCA inverseTransformPoint

* added inverseTransform to PCA RST

* off by one white space 😠

* normalize the desc/disc of mfcc entries (#113)

* HPSS Help file (RST) and SC examples (#81)

* HPSS rst edited and SC examples created

* pa feedback

* Enhance/generate stubs (#119)

* CMake: Generate cpp stubs, smooth out API for dependent projects

* Remove old stubs and scripts

* CMake: Ensure correct MSVC runtime by default

* Correct variable setting logic in macro

* CI: Debug CMAKE_MODULE_PATH

* CMake: Try setting module path using explicit source dir for core

* CI Debug: Print core/scripts

* CMake: Correct typo

* CMake: MSVC with bigobj, tidy up messages

* set explicit UTF8 encoding when opening text

* explicitly use utf8 for writing as well as reading

* MDS RST & SC example code (#121)

* MLPClassifier SC example code

* MLPClassifier SC example code ⚠️

* MLPs SC example code and RSTs ⚠️

* ⚠️

* ⚠️

* wip

* MLP RSTs

* [FIX] this commit adds code to the SC templates to allow enums in the RST to appear in the species data

* feedback

* hidden -> hiddenLayers

* ⚠️

* sc example ⚠️

* sc example code

* bump

* typo

* removed cosine

* weefuzzy and james feedback

* fixed plot size

* MLPRegressor & MLPClassifier RSTs & SC example Code (#109)

* MLPClassifier SC example code

* MLPClassifier SC example code ⚠️

* MLPs SC example code and RSTs ⚠️

* ⚠️

* ⚠️

* wip

* MLP RSTs

* [FIX] this commit adds code to the SC templates to allow enums in the RST to appear in the species data

* feedback

* hidden -> hiddenLayers

* Standardize RST & SC examples (#117)

* Standardize RST & SC example code

* removed the 'invert' argument

* added discussion

* RobustScale (#118)

* ⚠️

* RobustScale RST

* RobustScale SC example code

* bump

* added discussion

* KNNClassifier RST and SC example code (#127)

* KNN ⚠️

* reset knnregressor.rst

* Stats RST & SC examples (#124)

* Stats RST and SC code

* stats rst and sc code

* feedback

* PCA RST and SC Examples (#116)

* PCA RST

* PCA SC example code

* sc example code with whitening example

* added discussion

* james' feedback

Co-authored-by: James Bradbury <[email protected]>

* Update Standardize.rst

Fix indentation error that caused mis-parsing

* maxFFTSize in SC driver is conditional on buffer-proc species (#129)

* BufSTFT RST and SC example code (#112)

* BufSTFT RST and SC example code

* added discussion

* typo

* [Enhance] Learn platform link generation (#120)

* update default transformer to handle learn links

* update maxref template to acount for learn link

* add link to templates discussion

* compartmentalise the learn link derivation

* update the supercollider driver which doesnt use default transform

* use a regex instead of object map

* update derivation of learn links

* add test for link derivation

* typo

* bufnmf: adding resynthmode

* resynthMode : camel case

* Change size to history (#133)

* BufNMFCross RST & SC example (#137)

* NNDSVD (#138)

* ⚠️

* BufNNDSVD RST & SC examples

* NNDSVD RST with descriptions of method

* add token for |buffer|

* feedback

Co-authored-by: James Bradbury <[email protected]>

* NMFMorph (& species transformer[0]) (#135)

* NMFMorph RST and SC examples

* NMFMorph

* NMFMorph (and species transformer[0])

* separate discussion and description

* added comment about why autoassign is set twice

Co-authored-by: James Bradbury <[email protected]>

* put bar chart back in (#123)

* KNNRegressor (#136)

* KNNRegressor RST & SC examples

* fixed sc code formatting

* separate discussion and description!

* (Buf)Transients(Slice) Family (#140)

* transients RST

* ⚠️

* ⚠️

* more sc examples for transients family

* feedback from owen and alex

* feedback round 1

* feedback

* typos in rst

* typos in knnclassifier~ (#142)

* sc example code for BufNMF now includes resynthMode

* deleted SC Guid YAML file

* put spaces around hyperlinks

* BufTransients SC example (Waveform only 2 sec.)

* BufNNDSVD -> BufNMFSeed (#141)

* change the doc

* forgot to change the code sample file name

* fix Loudness select in MLPRegressor example code

* fix bad link in nmf morph (BufNMFCross was missing the buf part)

* added inverse transform and inverse transform point to Normalize

* better code for testing all flucoma objects help files

* added argument k to KDTree RST

* fixed a bad link in KNNClassifier RST

* removed action arguments from RobustScale RST

* fixed mistakes in RobustScale RST that was causing it to not render properly

* added select argument to BufLoudness and Loudness RST (the rest coming soon...)

* added pca whitening to PCA RST

* adding select argument to appropriate RST files

it would be nicer to have them in list form... TODO

* added radius argument to KDTree RST

* added channels argument to BufSelect RST

* checked example code files that use 'select' for possible errors

* found a bit more code needing resynthMode

* [Enhance] Interp to Interplation in NMFMorph (#143)

* typos in knnclassifier~

* change interp to interpolation for nmfmorph

* SKMeans (#132)

* skmeans doc commit

* skmeans: attempt at better doc

* example code a little more explicit

* typos found in kmeans

* update from @weefuzzy feedback - less untrue in most cases :)

* <fit>transform<point> -> <fit>encode<point>

* (Buf)AmpGate RST & SC examples (#122)

* (Buf)AmpGate RST & SC examples

* BufAmpGate help file ⚠️

* drum hit example ⚠️

* ⚠️

* gitignore to ignore vs code

* pa feedback

* added BufAmpGate maxSize parameter
jamesb93 pushed a commit that referenced this pull request Jun 15, 2022
* mfcc rst and sc help file

* mfcc sc examples

* mfcc output

* mfcc helpfile readability

* BufMFCC udpates

* update bufonsetslice docs slightly (#87)

* fix audio transport segmentation of discussion and desc

* fix audio transport segmentation of discussion and desc (#88)

* add missing see alsos

* optional args: add to C++ wrapper

* ParamDump and python: add choices param type

* Json driver (#35)

* Make jinja rendering conditional on driver having a template

* minimal driver for raw JSON output

* cmake target for raw JSON

* fix cmake output directory

* add command line option for raw

* remove spurious item from raw driver

* add back changes that dealt with conditional template rendering

* add a github action for creating a basic API on actions

Co-authored-by: James Bradbury <[email protected]>

* Update json_api.yml

* Update json_api.yml

* Update json_api.yml

* change name of raw output to api.json

* Update json_api.yml

* remove indentation on api

* typo in UMAP

* [Docs] OnsetSlice and BufOnsetSlice (#91)

* update bufonsetslice text

* onsetslice update

* ted's changes

* copy changes to bufonsetslice also

* revamp MelBands and BufMelBands RST, update SC example code

* *melbands description

* added a hyphen

* pitch and buf pitch RST

* added link to the learn page

* edited normalize description

* pitch sc help files

* BufFlatten RST and SC examples

* buf thresh

* sc help file

* typo in fluid pitch sc example code

* bufthresh rst

* typo

* james' feedback

* add .ds_store to gitignore

* pa feedback

* pa feedback

* pa feedback

* PA feedback

* [Docs] Update Normalize Docs (#76)

* update normalize entry

* update description

* pa's requests

Co-authored-by: James Bradbury <[email protected]>

* [Docs] Slicer Feature Objects (#101)

* add skeleton of bufnoveltyfeature

* caveat novelty feature

* add onset feature

* remove space

* add bufampfeature

* realtime amp feature

* update output of AmpFeature

* clean up the language

* caveats for bufonset feature

* add onset feature

* Add JSON generators for Slicers' feature counterparts

* rt noveltyfeature

* fix various errors

* robots in disguise

* change feature -> algorithm

* cleanup noveltyfeature

* make noveltyfeature more consistent

* remove superfluous spaces

* fix description

* fix reference to buffer version in rt object

* add padding

* sc example code for slicer-features

Co-authored-by: weefuzzy <[email protected]>
Co-authored-by: Ted Moore <[email protected]>

* changing preset and interface for noveltyslice examples

* Add argument handlers for const DataSet / LabelSet

* Max/PD: Generate docs for control-in objects (input size and autosize)

* Enhance/max params (#104)

* CMake: Centralise C++ version and set to 17

* Wrapper: Handle new LongRuntimeMax parameter type

* Doc generators: Handle new LongRuntimeMax type + rules for args in Max/PD

* Add a `striprst` jinja filter for removing rst markup in templates (#107)

Such as Max object level description tags

* UMAP cmake reference to python sorted

* typo

* Wrapper and doc-gen update for new `maxFFTSize`

* Buf stats (#103)

* BufStats RST

* BufStats ⚠️

* bufstats supercollider examples

* re-organized descriptions

* added table back in

* typo

* added url

* bufcompose update (#95)

* PCA inverseTransformPoint (#97)

* PCA inverseTransformPoint

* added inverseTransform to PCA RST

* off by one white space 😠

* normalize the desc/disc of mfcc entries (#113)

* HPSS Help file (RST) and SC examples (#81)

* HPSS rst edited and SC examples created

* pa feedback

* Enhance/generate stubs (#119)

* CMake: Generate cpp stubs, smooth out API for dependent projects

* Remove old stubs and scripts

* CMake: Ensure correct MSVC runtime by default

* Correct variable setting logic in macro

* CI: Debug CMAKE_MODULE_PATH

* CMake: Try setting module path using explicit source dir for core

* CI Debug: Print core/scripts

* CMake: Correct typo

* CMake: MSVC with bigobj, tidy up messages

* set explicit UTF8 encoding when opening text

* explicitly use utf8 for writing as well as reading

* MDS RST & SC example code (#121)

* MLPClassifier SC example code

* MLPClassifier SC example code ⚠️

* MLPs SC example code and RSTs ⚠️

* ⚠️

* ⚠️

* wip

* MLP RSTs

* [FIX] this commit adds code to the SC templates to allow enums in the RST to appear in the species data

* feedback

* hidden -> hiddenLayers

* ⚠️

* sc example ⚠️

* sc example code

* bump

* typo

* removed cosine

* weefuzzy and james feedback

* fixed plot size

* MLPRegressor & MLPClassifier RSTs & SC example Code (#109)

* MLPClassifier SC example code

* MLPClassifier SC example code ⚠️

* MLPs SC example code and RSTs ⚠️

* ⚠️

* ⚠️

* wip

* MLP RSTs

* [FIX] this commit adds code to the SC templates to allow enums in the RST to appear in the species data

* feedback

* hidden -> hiddenLayers

* Standardize RST & SC examples (#117)

* Standardize RST & SC example code

* removed the 'invert' argument

* added discussion

* RobustScale (#118)

* ⚠️

* RobustScale RST

* RobustScale SC example code

* bump

* added discussion

* KNNClassifier RST and SC example code (#127)

* KNN ⚠️

* reset knnregressor.rst

* Stats RST & SC examples (#124)

* Stats RST and SC code

* stats rst and sc code

* feedback

* PCA RST and SC Examples (#116)

* PCA RST

* PCA SC example code

* sc example code with whitening example

* added discussion

* james' feedback

Co-authored-by: James Bradbury <[email protected]>

* Update Standardize.rst

Fix indentation error that caused mis-parsing

* maxFFTSize in SC driver is conditional on buffer-proc species (#129)

* BufSTFT RST and SC example code (#112)

* BufSTFT RST and SC example code

* added discussion

* typo

* [Enhance] Learn platform link generation (#120)

* update default transformer to handle learn links

* update maxref template to acount for learn link

* add link to templates discussion

* compartmentalise the learn link derivation

* update the supercollider driver which doesnt use default transform

* use a regex instead of object map

* update derivation of learn links

* add test for link derivation

* typo

* bufnmf: adding resynthmode

* resynthMode : camel case

* Change size to history (#133)

* BufNMFCross RST & SC example (#137)

* NNDSVD (#138)

* ⚠️

* BufNNDSVD RST & SC examples

* NNDSVD RST with descriptions of method

* add token for |buffer|

* feedback

Co-authored-by: James Bradbury <[email protected]>

* NMFMorph (& species transformer[0]) (#135)

* NMFMorph RST and SC examples

* NMFMorph

* NMFMorph (and species transformer[0])

* separate discussion and description

* added comment about why autoassign is set twice

Co-authored-by: James Bradbury <[email protected]>

* put bar chart back in (#123)

* KNNRegressor (#136)

* KNNRegressor RST & SC examples

* fixed sc code formatting

* separate discussion and description!

* (Buf)Transients(Slice) Family (#140)

* transients RST

* ⚠️

* ⚠️

* more sc examples for transients family

* feedback from owen and alex

* feedback round 1

* feedback

* typos in rst

* typos in knnclassifier~ (#142)

* sc example code for BufNMF now includes resynthMode

* deleted SC Guid YAML file

* put spaces around hyperlinks

* BufTransients SC example (Waveform only 2 sec.)

* BufNNDSVD -> BufNMFSeed (#141)

* change the doc

* forgot to change the code sample file name

* fix Loudness select in MLPRegressor example code

* fix bad link in nmf morph (BufNMFCross was missing the buf part)

* added inverse transform and inverse transform point to Normalize

* better code for testing all flucoma objects help files

* added argument k to KDTree RST

* fixed a bad link in KNNClassifier RST

* removed action arguments from RobustScale RST

* fixed mistakes in RobustScale RST that was causing it to not render properly

* added select argument to BufLoudness and Loudness RST (the rest coming soon...)

* added pca whitening to PCA RST

* adding select argument to appropriate RST files

it would be nicer to have them in list form... TODO

* added radius argument to KDTree RST

* added channels argument to BufSelect RST

* checked example code files that use 'select' for possible errors

* found a bit more code needing resynthMode

* [Enhance] Interp to Interplation in NMFMorph (#143)

* typos in knnclassifier~

* change interp to interpolation for nmfmorph

* SKMeans (#132)

* skmeans doc commit

* skmeans: attempt at better doc

* example code a little more explicit

* typos found in kmeans

* update from @weefuzzy feedback - less untrue in most cases :)

* <fit>transform<point> -> <fit>encode<point>

* (Buf)AmpGate RST & SC examples (#122)

* (Buf)AmpGate RST & SC examples

* BufAmpGate help file ⚠️

* drum hit example ⚠️

* ⚠️

* gitignore to ignore vs code

* pa feedback

* added BufAmpGate maxSize parameter

* [Fix] Fix Guide Links in RST (#147)

* typos in knnclassifier~

* fix guide link
jamesb93 pushed a commit that referenced this pull request Jun 15, 2022
* mfcc rst and sc help file

* mfcc sc examples

* mfcc output

* mfcc helpfile readability

* BufMFCC udpates

* update bufonsetslice docs slightly (#87)

* fix audio transport segmentation of discussion and desc

* fix audio transport segmentation of discussion and desc (#88)

* add missing see alsos

* optional args: add to C++ wrapper

* ParamDump and python: add choices param type

* Json driver (#35)

* Make jinja rendering conditional on driver having a template

* minimal driver for raw JSON output

* cmake target for raw JSON

* fix cmake output directory

* add command line option for raw

* remove spurious item from raw driver

* add back changes that dealt with conditional template rendering

* add a github action for creating a basic API on actions

Co-authored-by: James Bradbury <[email protected]>

* Update json_api.yml

* Update json_api.yml

* Update json_api.yml

* change name of raw output to api.json

* Update json_api.yml

* remove indentation on api

* typo in UMAP

* [Docs] OnsetSlice and BufOnsetSlice (#91)

* update bufonsetslice text

* onsetslice update

* ted's changes

* copy changes to bufonsetslice also

* revamp MelBands and BufMelBands RST, update SC example code

* *melbands description

* added a hyphen

* pitch and buf pitch RST

* added link to the learn page

* edited normalize description

* pitch sc help files

* BufFlatten RST and SC examples

* buf thresh

* sc help file

* typo in fluid pitch sc example code

* bufthresh rst

* typo

* james' feedback

* add .ds_store to gitignore

* pa feedback

* pa feedback

* pa feedback

* PA feedback

* [Docs] Update Normalize Docs (#76)

* update normalize entry

* update description

* pa's requests

Co-authored-by: James Bradbury <[email protected]>

* [Docs] Slicer Feature Objects (#101)

* add skeleton of bufnoveltyfeature

* caveat novelty feature

* add onset feature

* remove space

* add bufampfeature

* realtime amp feature

* update output of AmpFeature

* clean up the language

* caveats for bufonset feature

* add onset feature

* Add JSON generators for Slicers' feature counterparts

* rt noveltyfeature

* fix various errors

* robots in disguise

* change feature -> algorithm

* cleanup noveltyfeature

* make noveltyfeature more consistent

* remove superfluous spaces

* fix description

* fix reference to buffer version in rt object

* add padding

* sc example code for slicer-features

Co-authored-by: weefuzzy <[email protected]>
Co-authored-by: Ted Moore <[email protected]>

* changing preset and interface for noveltyslice examples

* Add argument handlers for const DataSet / LabelSet

* Max/PD: Generate docs for control-in objects (input size and autosize)

* Enhance/max params (#104)

* CMake: Centralise C++ version and set to 17

* Wrapper: Handle new LongRuntimeMax parameter type

* Doc generators: Handle new LongRuntimeMax type + rules for args in Max/PD

* Add a `striprst` jinja filter for removing rst markup in templates (#107)

Such as Max object level description tags

* UMAP cmake reference to python sorted

* typo

* Wrapper and doc-gen update for new `maxFFTSize`

* Buf stats (#103)

* BufStats RST

* BufStats ⚠️

* bufstats supercollider examples

* re-organized descriptions

* added table back in

* typo

* added url

* bufcompose update (#95)

* PCA inverseTransformPoint (#97)

* PCA inverseTransformPoint

* added inverseTransform to PCA RST

* off by one white space 😠

* normalize the desc/disc of mfcc entries (#113)

* HPSS Help file (RST) and SC examples (#81)

* HPSS rst edited and SC examples created

* pa feedback

* Enhance/generate stubs (#119)

* CMake: Generate cpp stubs, smooth out API for dependent projects

* Remove old stubs and scripts

* CMake: Ensure correct MSVC runtime by default

* Correct variable setting logic in macro

* CI: Debug CMAKE_MODULE_PATH

* CMake: Try setting module path using explicit source dir for core

* CI Debug: Print core/scripts

* CMake: Correct typo

* CMake: MSVC with bigobj, tidy up messages

* set explicit UTF8 encoding when opening text

* explicitly use utf8 for writing as well as reading

* MDS RST & SC example code (#121)

* MLPClassifier SC example code

* MLPClassifier SC example code ⚠️

* MLPs SC example code and RSTs ⚠️

* ⚠️

* ⚠️

* wip

* MLP RSTs

* [FIX] this commit adds code to the SC templates to allow enums in the RST to appear in the species data

* feedback

* hidden -> hiddenLayers

* ⚠️

* sc example ⚠️

* sc example code

* bump

* typo

* removed cosine

* weefuzzy and james feedback

* fixed plot size

* MLPRegressor & MLPClassifier RSTs & SC example Code (#109)

* MLPClassifier SC example code

* MLPClassifier SC example code ⚠️

* MLPs SC example code and RSTs ⚠️

* ⚠️

* ⚠️

* wip

* MLP RSTs

* [FIX] this commit adds code to the SC templates to allow enums in the RST to appear in the species data

* feedback

* hidden -> hiddenLayers

* Standardize RST & SC examples (#117)

* Standardize RST & SC example code

* removed the 'invert' argument

* added discussion

* RobustScale (#118)

* ⚠️

* RobustScale RST

* RobustScale SC example code

* bump

* added discussion

* KNNClassifier RST and SC example code (#127)

* KNN ⚠️

* reset knnregressor.rst

* Stats RST & SC examples (#124)

* Stats RST and SC code

* stats rst and sc code

* feedback

* PCA RST and SC Examples (#116)

* PCA RST

* PCA SC example code

* sc example code with whitening example

* added discussion

* james' feedback

Co-authored-by: James Bradbury <[email protected]>

* Update Standardize.rst

Fix indentation error that caused mis-parsing

* maxFFTSize in SC driver is conditional on buffer-proc species (#129)

* BufSTFT RST and SC example code (#112)

* BufSTFT RST and SC example code

* added discussion

* typo

* [Enhance] Learn platform link generation (#120)

* update default transformer to handle learn links

* update maxref template to acount for learn link

* add link to templates discussion

* compartmentalise the learn link derivation

* update the supercollider driver which doesnt use default transform

* use a regex instead of object map

* update derivation of learn links

* add test for link derivation

* typo

* bufnmf: adding resynthmode

* resynthMode : camel case

* Change size to history (#133)

* BufNMFCross RST & SC example (#137)

* NNDSVD (#138)

* ⚠️

* BufNNDSVD RST & SC examples

* NNDSVD RST with descriptions of method

* add token for |buffer|

* feedback

Co-authored-by: James Bradbury <[email protected]>

* NMFMorph (& species transformer[0]) (#135)

* NMFMorph RST and SC examples

* NMFMorph

* NMFMorph (and species transformer[0])

* separate discussion and description

* added comment about why autoassign is set twice

Co-authored-by: James Bradbury <[email protected]>

* put bar chart back in (#123)

* KNNRegressor (#136)

* KNNRegressor RST & SC examples

* fixed sc code formatting

* separate discussion and description!

* (Buf)Transients(Slice) Family (#140)

* transients RST

* ⚠️

* ⚠️

* more sc examples for transients family

* feedback from owen and alex

* feedback round 1

* feedback

* typos in rst

* typos in knnclassifier~ (#142)

* sc example code for BufNMF now includes resynthMode

* deleted SC Guid YAML file

* put spaces around hyperlinks

* BufTransients SC example (Waveform only 2 sec.)

* BufNNDSVD -> BufNMFSeed (#141)

* change the doc

* forgot to change the code sample file name

* fix Loudness select in MLPRegressor example code

* fix bad link in nmf morph (BufNMFCross was missing the buf part)

* added inverse transform and inverse transform point to Normalize

* better code for testing all flucoma objects help files

* added argument k to KDTree RST

* fixed a bad link in KNNClassifier RST

* removed action arguments from RobustScale RST

* fixed mistakes in RobustScale RST that was causing it to not render properly

* added select argument to BufLoudness and Loudness RST (the rest coming soon...)

* added pca whitening to PCA RST

* adding select argument to appropriate RST files

it would be nicer to have them in list form... TODO

* added radius argument to KDTree RST

* added channels argument to BufSelect RST

* checked example code files that use 'select' for possible errors

* found a bit more code needing resynthMode

* [Enhance] Interp to Interplation in NMFMorph (#143)

* typos in knnclassifier~

* change interp to interpolation for nmfmorph

* SKMeans (#132)

* skmeans doc commit

* skmeans: attempt at better doc

* example code a little more explicit

* typos found in kmeans

* update from @weefuzzy feedback - less untrue in most cases :)

* <fit>transform<point> -> <fit>encode<point>

* (Buf)AmpGate RST & SC examples (#122)

* (Buf)AmpGate RST & SC examples

* BufAmpGate help file ⚠️

* drum hit example ⚠️

* ⚠️

* gitignore to ignore vs code

* pa feedback

* added BufAmpGate maxSize parameter

* [Fix] Fix Guide Links in RST (#147)

* typos in knnclassifier~

* fix guide link

* [Fix] LF line ending enforcement (#149)

* typos in knnclassifier~

* enforce newline='\n' on template writing
jamesb93 pushed a commit that referenced this pull request Jun 24, 2022
* mfcc rst and sc help file

* mfcc sc examples

* mfcc output

* mfcc helpfile readability

* BufMFCC udpates

* update bufonsetslice docs slightly (#87)

* fix audio transport segmentation of discussion and desc

* fix audio transport segmentation of discussion and desc (#88)

* add missing see alsos

* optional args: add to C++ wrapper

* ParamDump and python: add choices param type

* Json driver (#35)

* Make jinja rendering conditional on driver having a template

* minimal driver for raw JSON output

* cmake target for raw JSON

* fix cmake output directory

* add command line option for raw

* remove spurious item from raw driver

* add back changes that dealt with conditional template rendering

* add a github action for creating a basic API on actions

Co-authored-by: James Bradbury <[email protected]>

* Update json_api.yml

* Update json_api.yml

* Update json_api.yml

* change name of raw output to api.json

* Update json_api.yml

* remove indentation on api

* typo in UMAP

* [Docs] OnsetSlice and BufOnsetSlice (#91)

* update bufonsetslice text

* onsetslice update

* ted's changes

* copy changes to bufonsetslice also

* revamp MelBands and BufMelBands RST, update SC example code

* *melbands description

* added a hyphen

* pitch and buf pitch RST

* added link to the learn page

* edited normalize description

* pitch sc help files

* BufFlatten RST and SC examples

* buf thresh

* sc help file

* typo in fluid pitch sc example code

* bufthresh rst

* typo

* james' feedback

* add .ds_store to gitignore

* pa feedback

* pa feedback

* pa feedback

* PA feedback

* [Docs] Update Normalize Docs (#76)

* update normalize entry

* update description

* pa's requests

Co-authored-by: James Bradbury <[email protected]>

* [Docs] Slicer Feature Objects (#101)

* add skeleton of bufnoveltyfeature

* caveat novelty feature

* add onset feature

* remove space

* add bufampfeature

* realtime amp feature

* update output of AmpFeature

* clean up the language

* caveats for bufonset feature

* add onset feature

* Add JSON generators for Slicers' feature counterparts

* rt noveltyfeature

* fix various errors

* robots in disguise

* change feature -> algorithm

* cleanup noveltyfeature

* make noveltyfeature more consistent

* remove superfluous spaces

* fix description

* fix reference to buffer version in rt object

* add padding

* sc example code for slicer-features

Co-authored-by: weefuzzy <[email protected]>
Co-authored-by: Ted Moore <[email protected]>

* changing preset and interface for noveltyslice examples

* Add argument handlers for const DataSet / LabelSet

* Max/PD: Generate docs for control-in objects (input size and autosize)

* Enhance/max params (#104)

* CMake: Centralise C++ version and set to 17

* Wrapper: Handle new LongRuntimeMax parameter type

* Doc generators: Handle new LongRuntimeMax type + rules for args in Max/PD

* Add a `striprst` jinja filter for removing rst markup in templates (#107)

Such as Max object level description tags

* UMAP cmake reference to python sorted

* typo

* Wrapper and doc-gen update for new `maxFFTSize`

* Buf stats (#103)

* BufStats RST

* BufStats ⚠️

* bufstats supercollider examples

* re-organized descriptions

* added table back in

* typo

* added url

* bufcompose update (#95)

* PCA inverseTransformPoint (#97)

* PCA inverseTransformPoint

* added inverseTransform to PCA RST

* off by one white space 😠

* normalize the desc/disc of mfcc entries (#113)

* HPSS Help file (RST) and SC examples (#81)

* HPSS rst edited and SC examples created

* pa feedback

* Enhance/generate stubs (#119)

* CMake: Generate cpp stubs, smooth out API for dependent projects

* Remove old stubs and scripts

* CMake: Ensure correct MSVC runtime by default

* Correct variable setting logic in macro

* CI: Debug CMAKE_MODULE_PATH

* CMake: Try setting module path using explicit source dir for core

* CI Debug: Print core/scripts

* CMake: Correct typo

* CMake: MSVC with bigobj, tidy up messages

* set explicit UTF8 encoding when opening text

* explicitly use utf8 for writing as well as reading

* MDS RST & SC example code (#121)

* MLPClassifier SC example code

* MLPClassifier SC example code ⚠️

* MLPs SC example code and RSTs ⚠️

* ⚠️

* ⚠️

* wip

* MLP RSTs

* [FIX] this commit adds code to the SC templates to allow enums in the RST to appear in the species data

* feedback

* hidden -> hiddenLayers

* ⚠️

* sc example ⚠️

* sc example code

* bump

* typo

* removed cosine

* weefuzzy and james feedback

* fixed plot size

* MLPRegressor & MLPClassifier RSTs & SC example Code (#109)

* MLPClassifier SC example code

* MLPClassifier SC example code ⚠️

* MLPs SC example code and RSTs ⚠️

* ⚠️

* ⚠️

* wip

* MLP RSTs

* [FIX] this commit adds code to the SC templates to allow enums in the RST to appear in the species data

* feedback

* hidden -> hiddenLayers

* Standardize RST & SC examples (#117)

* Standardize RST & SC example code

* removed the 'invert' argument

* added discussion

* RobustScale (#118)

* ⚠️

* RobustScale RST

* RobustScale SC example code

* bump

* added discussion

* KNNClassifier RST and SC example code (#127)

* KNN ⚠️

* reset knnregressor.rst

* Stats RST & SC examples (#124)

* Stats RST and SC code

* stats rst and sc code

* feedback

* PCA RST and SC Examples (#116)

* PCA RST

* PCA SC example code

* sc example code with whitening example

* added discussion

* james' feedback

Co-authored-by: James Bradbury <[email protected]>

* Update Standardize.rst

Fix indentation error that caused mis-parsing

* maxFFTSize in SC driver is conditional on buffer-proc species (#129)

* BufSTFT RST and SC example code (#112)

* BufSTFT RST and SC example code

* added discussion

* typo

* [Enhance] Learn platform link generation (#120)

* update default transformer to handle learn links

* update maxref template to acount for learn link

* add link to templates discussion

* compartmentalise the learn link derivation

* update the supercollider driver which doesnt use default transform

* use a regex instead of object map

* update derivation of learn links

* add test for link derivation

* typo

* bufnmf: adding resynthmode

* resynthMode : camel case

* Change size to history (#133)

* BufNMFCross RST & SC example (#137)

* NNDSVD (#138)

* ⚠️

* BufNNDSVD RST & SC examples

* NNDSVD RST with descriptions of method

* add token for |buffer|

* feedback

Co-authored-by: James Bradbury <[email protected]>

* NMFMorph (& species transformer[0]) (#135)

* NMFMorph RST and SC examples

* NMFMorph

* NMFMorph (and species transformer[0])

* separate discussion and description

* added comment about why autoassign is set twice

Co-authored-by: James Bradbury <[email protected]>

* put bar chart back in (#123)

* KNNRegressor (#136)

* KNNRegressor RST & SC examples

* fixed sc code formatting

* separate discussion and description!

* (Buf)Transients(Slice) Family (#140)

* transients RST

* ⚠️

* ⚠️

* more sc examples for transients family

* feedback from owen and alex

* feedback round 1

* feedback

* typos in rst

* typos in knnclassifier~ (#142)

* sc example code for BufNMF now includes resynthMode

* deleted SC Guid YAML file

* put spaces around hyperlinks

* BufTransients SC example (Waveform only 2 sec.)

* BufNNDSVD -> BufNMFSeed (#141)

* change the doc

* forgot to change the code sample file name

* fix Loudness select in MLPRegressor example code

* fix bad link in nmf morph (BufNMFCross was missing the buf part)

* added inverse transform and inverse transform point to Normalize

* better code for testing all flucoma objects help files

* added argument k to KDTree RST

* fixed a bad link in KNNClassifier RST

* removed action arguments from RobustScale RST

* fixed mistakes in RobustScale RST that was causing it to not render properly

* added select argument to BufLoudness and Loudness RST (the rest coming soon...)

* added pca whitening to PCA RST

* adding select argument to appropriate RST files

it would be nicer to have them in list form... TODO

* added radius argument to KDTree RST

* added channels argument to BufSelect RST

* checked example code files that use 'select' for possible errors

* found a bit more code needing resynthMode

* [Enhance] Interp to Interplation in NMFMorph (#143)

* typos in knnclassifier~

* change interp to interpolation for nmfmorph

* SKMeans (#132)

* skmeans doc commit

* skmeans: attempt at better doc

* example code a little more explicit

* typos found in kmeans

* update from @weefuzzy feedback - less untrue in most cases :)

* <fit>transform<point> -> <fit>encode<point>

* (Buf)AmpGate RST & SC examples (#122)

* (Buf)AmpGate RST & SC examples

* BufAmpGate help file ⚠️

* drum hit example ⚠️

* ⚠️

* gitignore to ignore vs code

* pa feedback

* added BufAmpGate maxSize parameter

* [Fix] Fix Guide Links in RST (#147)

* typos in knnclassifier~

* fix guide link

* [Fix] LF line ending enforcement (#149)

* typos in knnclassifier~

* enforce newline='\n' on template writing

* interface changes

* capitalise beatRemember

* Fix `<o>` links to `buffer~` for max doc

* Mop up vestigial scdoc syntax

* correct reference to "class" in description

* [fix] typos and errors (#153)

* various typos

* remove hyphen

* more typos

* various typos/non-grammatical errors

* typos in example code

* remove bufNum

* fix low/mid/ min/median confusion

* [docs] Update see-also content (#155)

* update seealso

* realign table

* [docs] Buffer clients link to buffer management tutorial (#157)

* if client starts with buf link to buffer management tutorial

* use full name of guide

* use name of .maxvig rather than name attribute of <vignette>

* also dataset objects

* proposed layout improvement (#154)

* add outward links to RST and templat
jamesb93 pushed a commit that referenced this pull request Jun 30, 2022
* [Release] 1.0.0 (#158)

* mfcc rst and sc help file

* mfcc sc examples

* mfcc output

* mfcc helpfile readability

* BufMFCC udpates

* update bufonsetslice docs slightly (#87)

* fix audio transport segmentation of discussion and desc

* fix audio transport segmentation of discussion and desc (#88)

* add missing see alsos

* optional args: add to C++ wrapper

* ParamDump and python: add choices param type

* Json driver (#35)

* Make jinja rendering conditional on driver having a template

* minimal driver for raw JSON output

* cmake target for raw JSON

* fix cmake output directory

* add command line option for raw

* remove spurious item from raw driver

* add back changes that dealt with conditional template rendering

* add a github action for creating a basic API on actions

Co-authored-by: James Bradbury <[email protected]>

* Update json_api.yml

* Update json_api.yml

* Update json_api.yml

* change name of raw output to api.json

* Update json_api.yml

* remove indentation on api

* typo in UMAP

* [Docs] OnsetSlice and BufOnsetSlice (#91)

* update bufonsetslice text

* onsetslice update

* ted's changes

* copy changes to bufonsetslice also

* revamp MelBands and BufMelBands RST, update SC example code

* *melbands description

* added a hyphen

* pitch and buf pitch RST

* added link to the learn page

* edited normalize description

* pitch sc help files

* BufFlatten RST and SC examples

* buf thresh

* sc help file

* typo in fluid pitch sc example code

* bufthresh rst

* typo

* james' feedback

* add .ds_store to gitignore

* pa feedback

* pa feedback

* pa feedback

* PA feedback

* [Docs] Update Normalize Docs (#76)

* update normalize entry

* update description

* pa's requests

Co-authored-by: James Bradbury <[email protected]>

* [Docs] Slicer Feature Objects (#101)

* add skeleton of bufnoveltyfeature

* caveat novelty feature

* add onset feature

* remove space

* add bufampfeature

* realtime amp feature

* update output of AmpFeature

* clean up the language

* caveats for bufonset feature

* add onset feature

* Add JSON generators for Slicers' feature counterparts

* rt noveltyfeature

* fix various errors

* robots in disguise

* change feature -> algorithm

* cleanup noveltyfeature

* make noveltyfeature more consistent

* remove superfluous spaces

* fix description

* fix reference to buffer version in rt object

* add padding

* sc example code for slicer-features

Co-authored-by: weefuzzy <[email protected]>
Co-authored-by: Ted Moore <[email protected]>

* changing preset and interface for noveltyslice examples

* Add argument handlers for const DataSet / LabelSet

* Max/PD: Generate docs for control-in objects (input size and autosize)

* Enhance/max params (#104)

* CMake: Centralise C++ version and set to 17

* Wrapper: Handle new LongRuntimeMax parameter type

* Doc generators: Handle new LongRuntimeMax type + rules for args in Max/PD

* Add a `striprst` jinja filter for removing rst markup in templates (#107)

Such as Max object level description tags

* UMAP cmake reference to python sorted

* typo

* Wrapper and doc-gen update for new `maxFFTSize`

* Buf stats (#103)

* BufStats RST

* BufStats ⚠️

* bufstats supercollider examples

* re-organized descriptions

* added table back in

* typo

* added url

* bufcompose update (#95)

* PCA inverseTransformPoint (#97)

* PCA inverseTransformPoint

* added inverseTransform to PCA RST

* off by one white space 😠

* normalize the desc/disc of mfcc entries (#113)

* HPSS Help file (RST) and SC examples (#81)

* HPSS rst edited and SC examples created

* pa feedback

* Enhance/generate stubs (#119)

* CMake: Generate cpp stubs, smooth out API for dependent projects

* Remove old stubs and scripts

* CMake: Ensure correct MSVC runtime by default

* Correct variable setting logic in macro

* CI: Debug CMAKE_MODULE_PATH

* CMake: Try setting module path using explicit source dir for core

* CI Debug: Print core/scripts

* CMake: Correct typo

* CMake: MSVC with bigobj, tidy up messages

* set explicit UTF8 encoding when opening text

* explicitly use utf8 for writing as well as reading

* MDS RST & SC example code (#121)

* MLPClassifier SC example code

* MLPClassifier SC example code ⚠️

* MLPs SC example code and RSTs ⚠️

* ⚠️

* ⚠️

* wip

* MLP RSTs

* [FIX] this commit adds code to the SC templates to allow enums in the RST to appear in the species data

* feedback

* hidden -> hiddenLayers

* ⚠️

* sc example ⚠️

* sc example code

* bump

* typo

* removed cosine

* weefuzzy and james feedback

* fixed plot size

* MLPRegressor & MLPClassifier RSTs & SC example Code (#109)

* MLPClassifier SC example code

* MLPClassifier SC example code ⚠️

* MLPs SC example code and RSTs ⚠️

* ⚠️

* ⚠️

* wip

* MLP RSTs

* [FIX] this commit adds code to the SC templates to allow enums in the RST to appear in the species data

* feedback

* hidden -> hiddenLayers

* Standardize RST & SC examples (#117)

* Standardize RST & SC example code

* removed the 'invert' argument

* added discussion

* RobustScale (#118)

* ⚠️

* RobustScale RST

* RobustScale SC example code

* bump

* added discussion

* KNNClassifier RST and SC example code (#127)

* KNN ⚠️

* reset knnregressor.rst

* Stats RST & SC examples (#124)

* Stats RST and SC code

* stats rst and sc code

* feedback

* PCA RST and SC Examples (#116)

* PCA RST

* PCA SC example code

* sc example code with whitening example

* added discussion

* james' feedback

Co-authored-by: James Bradbury <[email protected]>

* Update Standardize.rst

Fix indentation error that caused mis-parsing

* maxFFTSize in SC driver is conditional on buffer-proc species (#129)

* BufSTFT RST and SC example code (#112)

* BufSTFT RST and SC example code

* added discussion

* typo

* [Enhance] Learn platform link generation (#120)

* update default transformer to handle learn links

* update maxref template to acount for learn link

* add link to templates discussion

* compartmentalise the learn link derivation

* update the supercollider driver which doesnt use default transform

* use a regex instead of object map

* update derivation of learn links

* add test for link derivation

* typo

* bufnmf: adding resynthmode

* resynthMode : camel case

* Change size to history (#133)

* BufNMFCross RST & SC example (#137)

* NNDSVD (#138)

* ⚠️

* BufNNDSVD RST & SC examples

* NNDSVD RST with descriptions of method

* add token for |buffer|

* feedback

Co-authored-by: James Bradbury <[email protected]>

* NMFMorph (& species transformer[0]) (#135)

* NMFMorph RST and SC examples

* NMFMorph

* NMFMorph (and species transformer[0])

* separate discussion and description

* added comment about why autoassign is set twice

Co-authored-by: James Bradbury <[email protected]>

* put bar chart back in (#123)

* KNNRegressor (#136)

* KNNRegressor RST & SC examples

* fixed sc code formatting

* separate discussion and description!

* (Buf)Transients(Slice) Family (#140)

* transients RST

* ⚠️

* ⚠️

* more sc examples for transients family

* feedback from owen and alex

* feedback round 1

* feedback

* typos in rst

* typos in knnclassifier~ (#142)

* sc example code for BufNMF now includes resynthMode

* deleted SC Guid YAML file

* put spaces around hyperlinks

* BufTransients SC example (Waveform only 2 sec.)

* BufNNDSVD -> BufNMFSeed (#141)

* change the doc

* forgot to change the code sample file name

* fix Loudness select in MLPRegressor example code

* fix bad link in nmf morph (BufNMFCross was missing the buf part)

* added inverse transform and inverse transform point to Normalize

* better code for testing all flucoma objects help files

* added argument k to KDTree RST

* fixed a bad link in KNNClassifier RST

* removed action arguments from RobustScale RST

* fixed mistakes in RobustScale RST that was causing it to not render properly

* added select argument to BufLoudness and Loudness RST (the rest coming soon...)

* added pca whitening to PCA RST

* adding select argument to appropriate RST files

it would be nicer to have them in list form... TODO

* added radius argument to KDTree RST

* added channels argument to BufSelect RST

* checked example code files that use 'select' for possible errors

* found a bit more code needing resynthMode

* [Enhance] Interp to Interplation in NMFMorph (#143)

* typos in knnclassifier~

* change interp to interpolation for nmfmorph

* SKMeans (#132)

* skmeans doc commit

* skmeans: attempt at better doc

* example code a little more explicit

* typos found in kmeans

* update from @weefuzzy feedback - less untrue in most cases :)

* <fit>transform<point> -> <fit>encode<point>

* (Buf)AmpGate RST & SC examples (#122)

* (Buf)AmpGate RST & SC examples

* BufAmpGate help file ⚠️

* drum hit example ⚠️

* ⚠️

* gitignore to ignore vs code

* pa feedback

* added BufAmpGate maxSize parameter

* [Fix] Fix Guide Links in RST (#147)

* typos in knnclassifier~

* fix guide link

* [Fix] LF line ending enforcement (#149)

* typos in knnclassifier~

* enforce newline='\n' on template writing

* interface changes

* capitalise beatRemember

* Fix `<o>` links to `buffer~` for max doc

* Mop up vestigial scdoc syntax

* correct reference to "class" in description

* [fix] typos and errors (#153)

* various typos

* remove hyphen

* more typos

* various typos/non-grammatical errors

* typos in example code

* remove bufNum

* fix low/mid/ min/median confusion

* [docs] Update see-also content (#155)

* update seealso

* realign table

* [docs] Buffer clients link to buffer management tutorial (#157)

* if client starts with buf link to buffer management tutorial

* use full name of guide

* use name of .maxvig rather than name attribute of <vignette>

* also dataset objects

* proposed layout improvement (#154)

* add outward links to RST and templat

* sample -> samples

* The index of the buffer -> The buffer

* process -> processed

* various other typos
@jamesb93 jamesb93 mentioned this pull request Jun 30, 2022
jamesb93 pushed a commit that referenced this pull request Jun 30, 2022
* mfcc rst and sc help file

* mfcc sc examples

* mfcc output

* mfcc helpfile readability

* BufMFCC udpates

* update bufonsetslice docs slightly (#87)

* fix audio transport segmentation of discussion and desc

* fix audio transport segmentation of discussion and desc (#88)

* add missing see alsos

* optional args: add to C++ wrapper

* ParamDump and python: add choices param type

* Json driver (#35)

* Make jinja rendering conditional on driver having a template

* minimal driver for raw JSON output

* cmake target for raw JSON

* fix cmake output directory

* add command line option for raw

* remove spurious item from raw driver

* add back changes that dealt with conditional template rendering

* add a github action for creating a basic API on actions

Co-authored-by: James Bradbury <[email protected]>

* Update json_api.yml

* Update json_api.yml

* Update json_api.yml

* change name of raw output to api.json

* Update json_api.yml

* remove indentation on api

* typo in UMAP

* [Docs] OnsetSlice and BufOnsetSlice (#91)

* update bufonsetslice text

* onsetslice update

* ted's changes

* copy changes to bufonsetslice also

* revamp MelBands and BufMelBands RST, update SC example code

* *melbands description

* added a hyphen

* pitch and buf pitch RST

* added link to the learn page

* edited normalize description

* pitch sc help files

* BufFlatten RST and SC examples

* buf thresh

* sc help file

* typo in fluid pitch sc example code

* bufthresh rst

* typo

* james' feedback

* add .ds_store to gitignore

* pa feedback

* pa feedback

* pa feedback

* PA feedback

* [Docs] Update Normalize Docs (#76)

* update normalize entry

* update description

* pa's requests

Co-authored-by: James Bradbury <[email protected]>

* [Docs] Slicer Feature Objects (#101)

* add skeleton of bufnoveltyfeature

* caveat novelty feature

* add onset feature

* remove space

* add bufampfeature

* realtime amp feature

* update output of AmpFeature

* clean up the language

* caveats for bufonset feature

* add onset feature

* Add JSON generators for Slicers' feature counterparts

* rt noveltyfeature

* fix various errors

* robots in disguise

* change feature -> algorithm

* cleanup noveltyfeature

* make noveltyfeature more consistent

* remove superfluous spaces

* fix description

* fix reference to buffer version in rt object

* add padding

* sc example code for slicer-features

Co-authored-by: weefuzzy <[email protected]>
Co-authored-by: Ted Moore <[email protected]>

* changing preset and interface for noveltyslice examples

* Add argument handlers for const DataSet / LabelSet

* Max/PD: Generate docs for control-in objects (input size and autosize)

* Enhance/max params (#104)

* CMake: Centralise C++ version and set to 17

* Wrapper: Handle new LongRuntimeMax parameter type

* Doc generators: Handle new LongRuntimeMax type + rules for args in Max/PD

* Add a `striprst` jinja filter for removing rst markup in templates (#107)

Such as Max object level description tags

* UMAP cmake reference to python sorted

* typo

* Wrapper and doc-gen update for new `maxFFTSize`

* Buf stats (#103)

* BufStats RST

* BufStats ⚠️

* bufstats supercollider examples

* re-organized descriptions

* added table back in

* typo

* added url

* bufcompose update (#95)

* PCA inverseTransformPoint (#97)

* PCA inverseTransformPoint

* added inverseTransform to PCA RST

* off by one white space 😠

* normalize the desc/disc of mfcc entries (#113)

* HPSS Help file (RST) and SC examples (#81)

* HPSS rst edited and SC examples created

* pa feedback

* Enhance/generate stubs (#119)

* CMake: Generate cpp stubs, smooth out API for dependent projects

* Remove old stubs and scripts

* CMake: Ensure correct MSVC runtime by default

* Correct variable setting logic in macro

* CI: Debug CMAKE_MODULE_PATH

* CMake: Try setting module path using explicit source dir for core

* CI Debug: Print core/scripts

* CMake: Correct typo

* CMake: MSVC with bigobj, tidy up messages

* set explicit UTF8 encoding when opening text

* explicitly use utf8 for writing as well as reading

* MDS RST & SC example code (#121)

* MLPClassifier SC example code

* MLPClassifier SC example code ⚠️

* MLPs SC example code and RSTs ⚠️

* ⚠️

* ⚠️

* wip

* MLP RSTs

* [FIX] this commit adds code to the SC templates to allow enums in the RST to appear in the species data

* feedback

* hidden -> hiddenLayers

* ⚠️

* sc example ⚠️

* sc example code

* bump

* typo

* removed cosine

* weefuzzy and james feedback

* fixed plot size

* MLPRegressor & MLPClassifier RSTs & SC example Code (#109)

* MLPClassifier SC example code

* MLPClassifier SC example code ⚠️

* MLPs SC example code and RSTs ⚠️

* ⚠️

* ⚠️

* wip

* MLP RSTs

* [FIX] this commit adds code to the SC templates to allow enums in the RST to appear in the species data

* feedback

* hidden -> hiddenLayers

* Standardize RST & SC examples (#117)

* Standardize RST & SC example code

* removed the 'invert' argument

* added discussion

* RobustScale (#118)

* ⚠️

* RobustScale RST

* RobustScale SC example code

* bump

* added discussion

* KNNClassifier RST and SC example code (#127)

* KNN ⚠️

* reset knnregressor.rst

* Stats RST & SC examples (#124)

* Stats RST and SC code

* stats rst and sc code

* feedback

* PCA RST and SC Examples (#116)

* PCA RST

* PCA SC example code

* sc example code with whitening example

* added discussion

* james' feedback

Co-authored-by: James Bradbury <[email protected]>

* Update Standardize.rst

Fix indentation error that caused mis-parsing

* maxFFTSize in SC driver is conditional on buffer-proc species (#129)

* BufSTFT RST and SC example code (#112)

* BufSTFT RST and SC example code

* added discussion

* typo

* [Enhance] Learn platform link generation (#120)

* update default transformer to handle learn links

* update maxref template to acount for learn link

* add link to templates discussion

* compartmentalise the learn link derivation

* update the supercollider driver which doesnt use default transform

* use a regex instead of object map

* update derivation of learn links

* add test for link derivation

* typo

* bufnmf: adding resynthmode

* resynthMode : camel case

* Change size to history (#133)

* BufNMFCross RST & SC example (#137)

* NNDSVD (#138)

* ⚠️

* BufNNDSVD RST & SC examples

* NNDSVD RST with descriptions of method

* add token for |buffer|

* feedback

Co-authored-by: James Bradbury <[email protected]>

* NMFMorph (& species transformer[0]) (#135)

* NMFMorph RST and SC examples

* NMFMorph

* NMFMorph (and species transformer[0])

* separate discussion and description

* added comment about why autoassign is set twice

Co-authored-by: James Bradbury <[email protected]>

* put bar chart back in (#123)

* KNNRegressor (#136)

* KNNRegressor RST & SC examples

* fixed sc code formatting

* separate discussion and description!

* (Buf)Transients(Slice) Family (#140)

* transients RST

* ⚠️

* ⚠️

* more sc examples for transients family

* feedback from owen and alex

* feedback round 1

* feedback

* typos in rst

* typos in knnclassifier~ (#142)

* sc example code for BufNMF now includes resynthMode

* deleted SC Guid YAML file

* put spaces around hyperlinks

* BufTransients SC example (Waveform only 2 sec.)

* BufNNDSVD -> BufNMFSeed (#141)

* change the doc

* forgot to change the code sample file name

* fix Loudness select in MLPRegressor example code

* fix bad link in nmf morph (BufNMFCross was missing the buf part)

* added inverse transform and inverse transform point to Normalize

* better code for testing all flucoma objects help files

* added argument k to KDTree RST

* fixed a bad link in KNNClassifier RST

* removed action arguments from RobustScale RST

* fixed mistakes in RobustScale RST that was causing it to not render properly

* added select argument to BufLoudness and Loudness RST (the rest coming soon...)

* added pca whitening to PCA RST

* adding select argument to appropriate RST files

it would be nicer to have them in list form... TODO

* added radius argument to KDTree RST

* added channels argument to BufSelect RST

* checked example code files that use 'select' for possible errors

* found a bit more code needing resynthMode

* [Enhance] Interp to Interplation in NMFMorph (#143)

* typos in knnclassifier~

* change interp to interpolation for nmfmorph

* SKMeans (#132)

* skmeans doc commit

* skmeans: attempt at better doc

* example code a little more explicit

* typos found in kmeans

* update from @weefuzzy feedback - less untrue in most cases :)

* <fit>transform<point> -> <fit>encode<point>

* (Buf)AmpGate RST & SC examples (#122)

* (Buf)AmpGate RST & SC examples

* BufAmpGate help file ⚠️

* drum hit example ⚠️

* ⚠️

* gitignore to ignore vs code

* pa feedback

* added BufAmpGate maxSize parameter

* [Fix] Fix Guide Links in RST (#147)

* typos in knnclassifier~

* fix guide link

* [Fix] LF line ending enforcement (#149)

* typos in knnclassifier~

* enforce newline='\n' on template writing

* interface changes

* capitalise beatRemember

* Fix `<o>` links to `buffer~` for max doc

* Mop up vestigial scdoc syntax

* correct reference to "class" in description

* [fix] typos and errors (#153)

* various typos

* remove hyphen

* more typos

* various typos/non-grammatical errors

* typos in example code

* remove bufNum

* fix low/mid/ min/median confusion

* [docs] Update see-also content (#155)

* update seealso

* realign table

* [docs] Buffer clients link to buffer management tutorial (#157)

* if client starts with buf link to buffer management tutorial

* use full name of guide

* use name of .maxvig rather than name attribute of <vignette>

* also dataset objects

* proposed layout improvement (#154)

* add outward links to RST and templat

* small typo in the *transient* family

* info on passing symbols for algorithm and metric to slicers (#160)

* Max to SC translation of example code (#151)

* max to sc translation batch 1

(buf)audiotransport, (buf)chroma, bufcompose, (buf)loudness, (buf)noveltyslice, bufscale, bufselect

* max to sc translation of example code round 2

* LabelSet

* Normalize

* SKMeans & UMAP example code translated from Max

* also check on the flucoma guide file

* removed extraneous postln in sc example

* [fix] typos (#161)

* [Release] 1.0.0 (#158)

* mfcc rst and sc help file

* mfcc sc examples

* mfcc output

* mfcc helpfile readability

* BufMFCC udpates

* update bufonsetslice docs slightly (#87)

* fix audio transport segmentation of discussion and desc

* fix audio transport segmentation of discussion and desc (#88)

* add missing see alsos

* optional args: add to C++ wrapper

* ParamDump and python: add choices param type

* Json driver (#35)

* Make jinja rendering conditional on driver having a template

* minimal driver for raw JSON output

* cmake target for raw JSON

* fix cmake output directory

* add command line option for raw

* remove spurious item from raw driver

* add back changes that dealt with conditional template rendering

* add a github action for creating a basic API on actions

Co-authored-by: James Bradbury <[email protected]>

* Update json_api.yml

* Update json_api.yml

* Update json_api.yml

* change name of raw output to api.json

* Update json_api.yml

* remove indentation on api

* typo in UMAP

* [Docs] OnsetSlice and BufOnsetSlice (#91)

* update bufonsetslice text

* onsetslice update

* ted's changes

* copy changes to bufonsetslice also

* revamp MelBands and BufMelBands RST, update SC example code

* *melbands description

* added a hyphen

* pitch and buf pitch RST

* added link to the learn page

* edited normalize description

* pitch sc help files

* BufFlatten RST and SC examples

* buf thresh

* sc help file

* typo in fluid pitch sc example code

* bufthresh rst

* typo

* james' feedback

* add .ds_store to gitignore

* pa feedback

* pa feedback

* pa feedback

* PA feedback

* [Docs] Update Normalize Docs (#76)

* update normalize entry

* update description

* pa's requests

Co-authored-by: James Bradbury <[email protected]>

* [Docs] Slicer Feature Objects (#101)

* add skeleton of bufnoveltyfeature

* caveat novelty feature

* add onset feature

* remove space

* add bufampfeature

* realtime amp feature

* update output of AmpFeature

* clean up the language

* caveats for bufonset feature

* add onset feature

* Add JSON generators for Slicers' feature counterparts

* rt noveltyfeature

* fix various errors

* robots in disguise

* change feature -> algorithm

* cleanup noveltyfeature

* make noveltyfeature more consistent

* remove superfluous spaces

* fix description

* fix reference to buffer version in rt object

* add padding

* sc example code for slicer-features

Co-authored-by: weefuzzy <[email protected]>
Co-authored-by: Ted Moore <[email protected]>

* changing preset and interface for noveltyslice examples

* Add argument handlers for const DataSet / LabelSet

* Max/PD: Generate docs for control-in objects (input size and autosize)

* Enhance/max params (#104)

* CMake: Centralise C++ version and set to 17

* Wrapper: Handle new LongRuntimeMax parameter type

* Doc generators: Handle new LongRuntimeMax type + rules for args in Max/PD

* Add a `striprst` jinja filter for removing rst markup in templates (#107)

Such as Max object level description tags

* UMAP cmake reference to python sorted

* typo

* Wrapper and doc-gen update for new `maxFFTSize`

* Buf stats (#103)

* BufStats RST

* BufStats ⚠️

* bufstats supercollider examples

* re-organized descriptions

* added table back in

* typo

* added url

* bufcompose update (#95)

* PCA inverseTransformPoint (#97)

* PCA inverseTransformPoint

* added inverseTransform to PCA RST

* off by one white space 😠

* normalize the desc/disc of mfcc entries (#113)

* HPSS Help file (RST) and SC examples (#81)

* HPSS rst edited and SC examples created

* pa feedback

* Enhance/generate stubs (#119)

* CMake: Generate cpp stubs, smooth out API for dependent projects

* Remove old stubs and scripts

* CMake: Ensure correct MSVC runtime by default

* Correct variable setting logic in macro

* CI: Debug CMAKE_MODULE_PATH

* CMake: Try setting module path using explicit source dir for core

* CI Debug: Print core/scripts

* CMake: Correct typo

* CMake: MSVC with bigobj, tidy up messages

* set explicit UTF8 encoding when opening text

* explicitly use utf8 for writing as well as reading

* MDS RST & SC example code (#121)

* MLPClassifier SC example code

* MLPClassifier SC example code ⚠️

* MLPs SC example code and RSTs ⚠️

* ⚠️

* ⚠️

* wip

* MLP RSTs

* [FIX] this commit adds code to the SC templates to allow enums in the RST to appear in the species data

* feedback

* hidden -> hiddenLayers

* ⚠️

* sc example ⚠️

* sc example code

* bump

* typo

* removed cosine

* weefuzzy and james feedback

* fixed plot size

* MLPRegressor & MLPClassifier RSTs & SC example Code (#109)

* MLPClassifier SC example code

* MLPClassifier SC example code ⚠️

* MLPs SC example code and RSTs ⚠️

* ⚠️

* ⚠️

* wip

* MLP RSTs

* [FIX] this commit adds code to the SC templates to allow enums in the RST to appear in the species data

* feedback

* hidden -> hiddenLayers

* Standardize RST & SC examples (#117)

* Standardize RST & SC example code

* removed the 'invert' argument

* added discussion

* RobustScale (#118)

* ⚠️

* RobustScale RST

* RobustScale SC example code

* bump

* added discussion

* KNNClassifier RST and SC example code (#127)

* KNN ⚠️

* reset knnregressor.rst

* Stats RST & SC examples (#124)

* Stats RST and SC code

* stats rst and sc code

* feedback

* PCA RST and SC Examples (#116)

* PCA RST

* PCA SC example code

* sc example code with whitening example

* added discussion

* james' feedback

Co-authored-by: James Bradbury <[email protected]>

* Update Standardize.rst

Fix indentation error that caused mis-parsing

* maxFFTSize in SC driver is conditional on buffer-proc species (#129)

* BufSTFT RST and SC example code (#112)

* BufSTFT RST and SC example code

* added discussion

* typo

* [Enhance] Learn platform link generation (#120)

* update default transformer to handle learn links

* update maxref template to acount for learn link

* add link to templates discussion

* compartmentalise the learn link derivation

* update the supercollider driver which doesnt use default transform

* use a regex instead of object map

* update derivation of learn links

* add test for link derivation

* typo

* bufnmf: adding resynthmode

* resynthMode : camel case

* Change size to history (#133)

* BufNMFCross RST & SC example (#137)

* NNDSVD (#138)

* ⚠️

* BufNNDSVD RST & SC examples

* NNDSVD RST with descriptions of method

* add token for |buffer|

* feedback

Co-authored-by: James Bradbury <[email protected]>

* NMFMorph (& species transformer[0]) (#135)

* NMFMorph RST and SC examples

* NMFMorph

* NMFMorph (and species transformer[0])

* separate discussion and description

* added comment about why autoassign is set twice

Co-authored-by: James Bradbury <[email protected]>

* put bar chart back in (#123)

* KNNRegressor (#136)

* KNNRegressor RST & SC examples

* fixed sc code formatting

* separate discussion and description!

* (Buf)Transients(Slice) Family (#140)

* transients RST

* ⚠️

* ⚠️

* more sc examples for transients family

* feedback from owen and alex

* feedback round 1

* feedback

* typos in rst

* typos in knnclassifier~ (#142)

* sc example code for BufNMF now includes resynthMode

* deleted SC Guid YAML file

* put spaces around hyperlinks

* BufTransients SC example (Waveform only 2 sec.)

* BufNNDSVD -> BufNMFSeed (#141)

* change the doc

* forgot to change the code sample file name

* fix Loudness select in MLPRegressor example code

* fix bad link in nmf morph (BufNMFCross was missing the buf part)

* added inverse transform and inverse transform point to Normalize

* better code for testing all flucoma objects help files

* added argument k to KDTree RST

* fixed a bad link in KNNClassifier RST

* removed action arguments from RobustScale RST

* fixed mistakes in RobustScale RST that was causing it to not render properly

* added select argument to BufLoudness and Loudness RST (the rest coming soon...)

* added pca whitening to PCA RST

* adding select argument to appropriate RST files

it would be nicer to have them in list form... TODO

* added radius argument to KDTree RST

* added channels argument to BufSelect RST

* checked example code files that use 'select' for possible errors

* found a bit more code needing resynthMode

* [Enhance] Interp to Interplation in NMFMorph (#143)

* typos in knnclassifier~

* change interp to interpolation for nmfmorph

* SKMeans (#132)

* skmeans doc commit

* skmeans: attempt at better doc

* example code a little more explicit

* typos found in kmeans

* update from @weefuzzy feedback - less untrue in most cases :)

* <fit>transform<point> -> <fit>encode<point>

* (Buf)AmpGate RST & SC examples (#122)

* (Buf)AmpGate RST & SC examples

* BufAmpGate help file ⚠️

* drum hit example ⚠️

* ⚠️

* gitignore to ignore vs code

* pa feedback

* added BufAmpGate maxSize parameter

* [Fix] Fix Guide Links in RST (#147)

* typos in knnclassifier~

* fix guide link

* [Fix] LF line ending enforcement (#149)

* typos in knnclassifier~

* enforce newline='\n' on template writing

* interface changes

* capitalise beatRemember

* Fix `<o>` links to `buffer~` for max doc

* Mop up vestigial scdoc syntax

* correct reference to "class" in description

* [fix] typos and errors (#153)

* various typos

* remove hyphen

* more typos

* various typos/non-grammatical errors

* typos in example code

* remove bufNum

* fix low/mid/ min/median confusion

* [docs] Update see-also content (#155)

* update seealso

* realign table

* [docs] Buffer clients link to buffer management tutorial (#157)

* if client starts with buf link to buffer management tutorial

* use full name of guide

* use name of .maxvig rather than name attribute of <vignette>

* also dataset objects

* proposed layout improvement (#154)

* add outward links to RST and templat

* sample -> samples

* The index of the buffer -> The buffer

* process -> processed

* various other typos
@weefuzzy weefuzzy deleted the HPSS-rst-and-SC-examples branch February 21, 2023 09:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants