Skip to content

Commit 240b252

Browse files
author
James Bradbury
authored
[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
1 parent 3242f4f commit 240b252

37 files changed

+78
-82
lines changed

‎doc/AmpGate.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
:description: Absolute amplitude threshold gate detector on a realtime signal
88

99
:discussion:
10-
AmpGate outputs a audio-rate, single-channel signal that is either 0, indicating the gate is closed, or 1, indicating the gate is open. The gate detects an onset (opens) when the internal envelope follower (controlled by ``rampUp`` and ``rampDown``) goes above a specified ``onThreshold`` (in dB) for at least ``minLengthAbove`` samples. The gate will stay open until the envelope follower goes below ``offThreshold`` (in dB) for at least ``minLengthBelow`` samples, which triggers an offset.
10+
AmpGate outputs an audio-rate, single-channel signal that is either 0, indicating the gate is closed, or 1, indicating the gate is open. The gate detects an onset (opens) when the internal envelope follower (controlled by ``rampUp`` and ``rampDown``) goes above a specified ``onThreshold`` (in dB) for at least ``minLengthAbove`` samples. The gate will stay open until the envelope follower goes below ``offThreshold`` (in dB) for at least ``minLengthBelow`` samples, which triggers an offset.
1111

1212
The latency between the input and the output is **max(minLengthAbove + lookBack, max(minLengthBelow,lookAhead))**.
1313

‎doc/AudioTransport.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626

2727
:control hopSize:
2828

29-
The window hop size in samples. As HPSS relies on spectral frames, we need to move the window forward. It can be any size but low overlap may create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2).
29+
The window hop size in samples. As HPSS relies on spectral frames, we need to move the window forward. It can be any size, but low overlap may create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2).
3030

3131
:control fftSize:
3232

‎doc/BufAmpFeature.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@
1313

1414
:control source:
1515

16-
The index of the buffer to use as the source material to be sliced through novelty identification. The different channels of multichannel buffers will be summed.
16+
The buffer to use as the source material to be sliced through novelty identification. The different channels of multichannel buffers will be summed.
1717

1818
:control startFrame:
1919

20-
Where in the srcBuf should the slicing process start, in sample.
20+
Where in the srcBuf should the slicing process start, in samples.
2121

2222
:control numFrames:
2323

@@ -33,7 +33,7 @@
3333

3434
:control features:
3535

36-
The index of the buffer where the amplitude differential feature will be copied to.
36+
The buffer where the amplitude differential feature will be copied to.
3737

3838
:control fastRampUp:
3939

‎doc/BufAmpGate.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636

3737
:control indices:
3838

39-
The buffer to write the gate information into. Buffer will be resized appropriately so each frame contains an onset (opening) position on channel 0 and the corresponding offset (closing) position on channel 1 (both in samples). The buffer will have as many frames as gate events detected.
39+
The buffer to write the gate information into. Buffer will be resized appropriately so that each frame contains an onset (opening) position on channel 0 and the corresponding offset (closing) position on channel 1 (both in samples). The buffer will have as many frames as gate events detected.
4040

4141
:control rampUp:
4242

‎doc/BufAmpSlice.rst‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,18 @@
88
:discussion:
99
FluidBufAmpSlice is based on two envelope followers on a high-passed version of the signal: one slow that gives the trend, and one fast. Each has features that will interact. The example code below is unfolding the various possibilities in order of complexity.
1010

11-
The process will return a buffer which contains indices (in sample) of estimated starting points of different slices.
11+
The process will return a buffer which contains indices (in samples) of estimated starting points of different slices.
1212

1313
:output: Nothing, as the destination buffer is declared in the function call.
1414

1515

1616
:control source:
1717

18-
The index of the buffer to use as the source material to be sliced through novelty identification. The different channels of multichannel buffers will be summed.
18+
The buffer to use as the source material to be sliced through novelty identification. The different channels of multichannel buffers will be summed.
1919

2020
:control startFrame:
2121

22-
Where in the srcBuf should the slicing process start, in sample.
22+
Where in the srcBuf should the slicing process start, in samples.
2323

2424
:control numFrames:
2525

@@ -35,7 +35,7 @@
3535

3636
:control indices:
3737

38-
The index of the buffer where the indices (in sample) of the estimated starting points of slices will be written. The first and last points are always the boundary points of the analysis.
38+
The buffer where the indices (in samples) of the estimated starting points of slices will be written. The first and last points are always the boundary points of the analysis.
3939

4040
:control fastRampUp:
4141

‎doc/BufAudioTransport.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@
6767

6868
:control hopSize:
6969

70-
The window hop size. As sinusoidal estimation relies on spectral frames, we need to move the window forward. It can be any size but low overlap will create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2).
70+
The window hop size. As sinusoidal estimation relies on spectral frames, we need to move the window forward. It can be any size, but low overlap will create audible artefacts. The -1 default value will default to half of windowSize (overlap of 2).
7171

7272
:control fftSize:
7373

‎doc/BufChroma.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@
1515

1616
:control source:
1717

18-
The index of the buffer to use as the source material to be analysed. The different channels of multichannel buffers will be processed sequentially.
18+
The buffer to use as the source material to be analysed. The different channels of multichannel buffers will be processed sequentially.
1919

2020
:control startFrame:
2121

22-
Where in the srcBuf should the process start, in sample.
22+
Where in the srcBuf should the process start, in samples.
2323

2424
:control numFrames:
2525

@@ -63,7 +63,7 @@
6363

6464
:control hopSize:
6565

66-
The window hop size. As chroma description relies on spectral frames, we need to move the window forward. It can be any size but low overlap will create audible artefacts.
66+
The window hop size. As chroma description relies on spectral frames, we need to move the window forward. It can be any size, but low overlap will create audible artefacts.
6767

6868
:control fftSize:
6969

‎doc/BufCompose.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
A utility for manipulating the contents of buffers.
99

1010
:discussion:
11-
This object is the swiss army knife for manipulating buffers and their contents. By specifying ranges of samples and channels to copy, as well as destination and source gains it can provide a powerful interface for performing actions such as a Left/Right to Mid/Side conversion and mixing down multichannel audio
11+
This object is a low-level tool for manipulating buffers and their contents. By specifying ranges of samples and channels to copy, as well as destination and source gains it can provide a powerful interface for performing actions such as a Left/Right to Mid/Side conversion and mixing down multichannel audio
1212

1313
:process: This method triggers the compositing.
1414

‎doc/BufHPSS.rst‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929

3030
:control source:
3131

32-
The index of the buffer to use as the source material. The channels of multichannel buffers will be processed sequentially.
32+
The buffer to use as the source material. The channels of multichannel buffers will be processed sequentially.
3333

3434
:control startFrame:
3535

@@ -49,15 +49,15 @@
4949

5050
:control harmonic:
5151

52-
The index of the buffer where the extracted harmonic component will be reconstructed.
52+
The buffer where the extracted harmonic component will be reconstructed.
5353

5454
:control percussive:
5555

56-
The index of the buffer where the extracted percussive component will be reconstructed.
56+
The buffer where the extracted percussive component will be reconstructed.
5757

5858
:control residual:
5959

60-
The index of the buffer where the residual component will be reconstructed in mode 2.
60+
The buffer where the residual component will be reconstructed in mode 2.
6161

6262
:control harmFilterSize:
6363

@@ -96,7 +96,7 @@
9696

9797
:control hopSize:
9898

99-
The hop size in samples. As HPSS relies on spectral frames, we need to move the window forward. It can be any size but low overlap may create audible artefacts.
99+
The hop size in samples. As HPSS relies on spectral frames, we need to move the window forward. It can be any size, but low overlap may create audible artefacts.
100100

101101
:control fftSize:
102102

‎doc/BufLoudness.rst‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@
1818

1919
:control source:
2020

21-
The index of the buffer to use as the source material to be described. The different channels of multichannel buffers will be processed sequentially.
21+
The buffer to use as the source material to be described. The different channels of multichannel buffers will be processed sequentially.
2222

2323
:control startFrame:
2424

25-
Where in the srcBuf should the process start, in sample.
25+
Where in the srcBuf should the process start, in samples.
2626

2727
:control numFrames:
2828

@@ -54,11 +54,11 @@
5454

5555
:control windowSize:
5656

57-
The size of the window on which the computation is done. By default 1024 to be similar with all other FluCoMa objects, the EBU specifies 400ms, which is 17640 samples at 44100.
57+
The size of the window on which the computation is done. By default, 1024 to be similar with all other FluCoMa objects, the EBU specifies 400ms, which is 17640 samples at 44100.
5858

5959
:control hopSize:
6060

61-
How much the buffered window moves forward, in samples. By default 512 to be similar with all other FluCoMa objects, the EBU specifies 100ms, which is 4410 samples at 44100.
61+
How much the buffered window moves forward, in samples. By default, 512 to be similar with all other FluCoMa objects, the EBU specifies 100ms, which is 4410 samples at 44100.
6262

6363
:control padding:
6464

0 commit comments

Comments
 (0)