diff --git a/release-packaging/HelpSource/Guides/FluCoMa.schelp b/release-packaging/HelpSource/Guides/FluCoMa.schelp index 0f16dc3..bd55234 100644 --- a/release-packaging/HelpSource/Guides/FluCoMa.schelp +++ b/release-packaging/HelpSource/Guides/FluCoMa.schelp @@ -1,11 +1,11 @@ title:: The Fluid Corpus Manipulation Project summary:: This section gives an overview of the Fluid Corpus Manipulation Project categories:: Libraries>FluidDecomposition -related:: Classes/FluidBufNMF +related:: Classes/FluidBufNMF, Guides/FluidDecomposition description:: The Fluid Corpus Manipulation project (FluCoMA) instigates new musical ways of exploiting ever-growing banks of sound and gestures within the digital composition process, by bringing breakthroughs of signal decomposition DSP and machine learning to the toolset of techno-fluent computer composers, creative coders and digital artists. The first set of tools released is the LINK:: Guides/FluidDecomposition:: This was made possible thanks to a grant by the European Research Council ( https://erc.europa.eu/ ) under the European Union’s Horizon 2020 research and innovation programme (grant agreement No 725899). -For more information, including a forum and learning material, please visit the FluCoMa project website at http://www.flucoma.org/ \ No newline at end of file +For more information, including a forum and learning material, please visit the FluCoMa project website at http://www.flucoma.org/ diff --git a/release-packaging/HelpSource/Guides/FluidBufMultiThreading.schelp b/release-packaging/HelpSource/Guides/FluidBufMultiThreading.schelp index f1f1e49..5ec317f 100644 --- a/release-packaging/HelpSource/Guides/FluidBufMultiThreading.schelp +++ b/release-packaging/HelpSource/Guides/FluidBufMultiThreading.schelp @@ -1,6 +1,6 @@ TITLE:: FluidBuf* Multithreading Behaviour SUMMARY:: A tutorial on the multithreading behaviour of offline processes of the Fluid Decomposition toolbox for signal decomposition -CATEGORIES:: Libraries>FluidDecomposition +CATEGORIES:: Libraries>FluidDecomposition, Guides>FluCoMa RELATED:: Guides/FluCoMa, Guides/FluidDecomposition DESCRIPTION:: diff --git a/release-packaging/HelpSource/Guides/FluidDataTools.schelp b/release-packaging/HelpSource/Guides/FluidDataTools.schelp new file mode 100644 index 0000000..0c5c754 --- /dev/null +++ b/release-packaging/HelpSource/Guides/FluidDataTools.schelp @@ -0,0 +1,64 @@ +title:: The Fluid Corpus Manipulation Data Tools +summary:: Tools for organising, exploring and querying corpora +categories:: Libraries>FluidDecomposition,Guides>FluCoMa +related:: Guides/FluCoMa, Guides/FluidDecomposition, Classes/FluidDataSet,Classes/FluidLabelSet + +The suite of Fluid Corpus Manipulation data tools offer facilities for building, exploring, transforming and playing with corpora. The tools are built around two container classes, link::Classes/FluidDataSet:: and link::Classes/FluidLabelSet::, which provides a way to build up and stored collections of labelled data, and a suite of objects that act on these containers. + +The design and interface of many of these objects is heavily based on the Python library link::https://scikit-learn.org/stable/##scikit-learn::, a mature and well developed machine learning toolkit that is comparatively quick to get going with. As our documentation continues to develop, we will also lean quite heavily on sci-learn's! + +section:: Containers + +Map id labels to data points, or to other labels + +link::Classes/FluidDataSet:: +link::Classes/FluidLabelSet:: + + +section:: DataSet Filtering + +Select and filter items from FluidDataSet by building queries + +link::Classes/FluidDataSetQuery:: + +section:: Data Structure + +Perform nearest neighbour searches + +link::Classes/FluidKDTree:: + +section:: Data Conditioning + +Pre-process data + +link::Classes/FluidNormalize:: + +link::Classes/FluidStandardize:: + +section:: Dimension Reduction + +Compress data to fewer dimensions for visualisation / efficiency / preprocessing + +link::Classes/FluidPCA:: + +link::Classes/FluidMDS:: + +section:: Supervised Learning + +Train supervised learning models using either K nearest neighbours or a simple neural network + +subsection:: Classification + +Map input data points to categories + +link::Classes/FluidKNNClassifier:: + +link::Classes/FluidMLPClassifier:: + +subsection:: Regression + +Map input data points to continuous output + +link::Classes/FluidKNNRegressor:: + +link::Classes/FluidMLPRegressor:: diff --git a/release-packaging/HelpSource/Guides/FluidDecomposition.schelp b/release-packaging/HelpSource/Guides/FluidDecomposition.schelp index bfe55a0..2f5f49d 100644 --- a/release-packaging/HelpSource/Guides/FluidDecomposition.schelp +++ b/release-packaging/HelpSource/Guides/FluidDecomposition.schelp @@ -1,6 +1,6 @@ TITLE:: Fluid Decomposition Toolbox SUMMARY:: An overview of the FluCoMa toolbox for signal decomposition -CATEGORIES:: Libraries>FluidDecomposition +CATEGORIES:: Libraries>FluidDecomposition, Guides>FluCoMa DESCRIPTION:: The Fluid Decomposition toolbox provides an open-ended, loosely coupled set of objects to break up and analyse sound in terms of slices (segments in time), layers (superpositions in time and frequency) and objects (configurable or discoverable patterns in sound). Almost all objects have audio-rate and buffer-based versions. footnote::