remove dangling references to servers from SC doc

tremblap · tremblap · commit e11505435d54 · 2021-06-01T10:30:27.000+01:00
diff --git a/doc/BufCompose.yaml b/doc/BufCompose.yaml
@@ -9,9 +9,9 @@
 digest: Buffer Compositing Utility
 sc-categories: Libraries>FluidDecomposition, UGens>Buffer
 sc-related: Guides/FluCoMa, Guides/FluidDecomposition, Classes/Buffer
-see-also: 
+see-also:
 description: |
-  A flexible utility for combining the contents of buffers on the server. It can be used for thing like mixing down multichannel buffers, or converting from left-right stereo to mid-side. It is used extensively in the example code of Fluid Decomposition.
+  A flexible utility for combining the contents of buffers. It can be used for thing like mixing down multichannel buffers, or converting from left-right stereo to mid-side. It is used extensively in the example code of Fluid Decomposition.
 discussion: |
   At its most simple, the object copies the content of a source buffer into a destination buffer. The flexibility comes from the various flags controlling which portions and channels of the source to use, and by applying gains (which can be positive or negative) to the source data and the portion of the destination that would be overwritten.
 
diff --git a/doc/BufFlatten.yaml b/doc/BufFlatten.yaml
@@ -6,7 +6,7 @@
 # under the European Union’s Horizon 2020 research and innovation programme
 # (grant agreement No 725899).
 ---
-digest: Flatten a multichannel buffer on the server
+digest: Flatten a multichannel buffer
 sc-categries: FluidCorpusManipulation
 sc-related: Classes/Buffer
 see-also:
diff --git a/doc/BufMFCC.yaml b/doc/BufMFCC.yaml
@@ -15,10 +15,6 @@ description: |
 
   The process will return a single multichannel buffer of **numCoeffs** per input channel. Each frame represents a value, which is every hopSize.
 
-  **Threading**
-
-  By default, this UGen spawns a new thread to avoid blocking the server command queue, so it is free to go about with its business. For a more detailed discussion of the available threading and monitoring options, including the two undocumented Class Methods below (.processBlocking and .kr) please read the guide Guides/FluidBufMultiThreading.
-
 parameters:
   source:
     description: |
diff --git a/doc/BufScale.yaml b/doc/BufScale.yaml
@@ -15,10 +15,6 @@ description: |
 
   The process will return a buffer with the same size and shape than the requested range.
 
-  **Threading**
-
-  By default, this UGen spawns a new thread to avoid blocking the server command queue, so it is free to go about with its business. For a more detailed discussion of the available threading and monitoring options, including the two undocumented Class Methods below (.processBlocking and .kr) please read the guide :fluid-topic:`FluidBufMultiThreading`.
-
 parameters:
   source:
     description: |
diff --git a/doc/BufThresh.yaml b/doc/BufThresh.yaml
@@ -9,16 +9,12 @@
 digest: A Gate Processor for Buffers
 sc-categries: Libraries>FluidDecomposition
 sc-related: Guides/FluCoMa, Guides/FluidDecomposition, Guides/FluidBufMultiThreading
-see-also: 
+see-also:
 description: |
   This class implements a simple Buffer preprocessor, by replacing values under a threshold by 0s. It is part of the :fluid-topic:`FluidDecomposition` of `Guides/FluCoMa`. For more explanations, learning material, and discussions on its musicianly uses, visit http://www.flucoma.org/
 
   The process will return a buffer with the same size and shape than the requested range.
 
-  **Threading**
-
-  By default, this UGen spawns a new thread to avoid blocking the server command queue, so it is free to go about with its business. For a more detailed discussion of the available threading and monitoring options, including the two undocumented Class Methods below (.processBlocking and .kr) please read the guide :fluid-topic:`FluidBufMultiThreading`.
-
 parameters:
   source:
     description: |
diff --git a/doc/Chroma.yaml b/doc/Chroma.yaml
@@ -14,7 +14,8 @@ description: This class computes a histogram of the energy contained for each pi
 discussion: |
   Also known as a chromagram, this typically allows you to get a contour of how much each semitone is represented in the spectrum over time. The number of chroma bins (and, thus, pitch classes) and the central reference frequency can be adjusted.
 
-  The process will return a multichannel control steam of size maxNumChroma, which will be repeated if no change happens within the algorithm, i.e. when the hopSize is larger than the server's kr period.
+  The process will return a multichannel control steam of size maxNumChroma, which will be repeated if no change happens within the algorithm, i.e. when the hopSize is larger than the signal vector size.
+
 process: The audio rate in, control rate out version of the object.
 parameters:
   in:
diff --git a/doc/DataSet.yaml b/doc/DataSet.yaml
@@ -11,7 +11,7 @@ sc-categries: UGens>FluidManipulation
 sc-related: Classes/FluidLabelSet, Classes/FluidKDTree, Classes/FluidKNN, Classes/FluidKMeans
 see-also:
 description: |
-  A server-side container associating labels with multi-dimensional data. FluidDataSet is identified by its name.
+  A container associating labels with multi-dimensional data. FluidDataSet is identified by its name.
 
 parameters:
   name:
@@ -106,18 +106,10 @@ messages:
      - name: action
        description: |
          A function to run when the merge has happened. ​​
-  free:
-   description: |
-      Destroy the object on the server.
-   args:
   print:
    description: |
       Post an abbreviated content of the DataSet in the window by default, but you can supply a custom action instead. ​​
    args:
-  synth:
-   description: |
-      The internal synth the object uses to communicate with the server
-   args:
   server:
    description: |
       The server instance the object uses ​
diff --git a/doc/KDTree.yaml b/doc/KDTree.yaml
@@ -6,12 +6,12 @@
 # under the European Union’s Horizon 2020 research and innovation programme
 # (grant agreement No 725899).
 ---
-digest: KD Tree on the server
+digest: KD Tree
 sc-categries: FluidManipulation
 sc-related: Classes/FluidDataSet
-see-also: 
+see-also:
 description: |
-  A server-side K-Dimensional tree for efficient neighbourhood searches of multi-dimensional data.
+  A K-Dimensional tree for efficient neighbourhood searches of multi-dimensional data.
 
   See https://scikit-learn.org/stable/modules/neighbors.html#nearest-neighbor-algorithms for more on KD Trees
 
@@ -21,8 +21,8 @@ parameters:
       The number of neighbours to return.
   dataSet:
     description: |
-      An optional :fluid-obj:`DataSet` from which data points will be returned for realtime queries. This does not need to be the same DataSet that the tree was fitted against, but does need to have matching labels. Using this mechanism, we have a way to, e.g. associate labels with segments of playback buffers, without needing pass strings around the server.
-messages: 
+      An optional :fluid-obj:`DataSet` from which data points will be returned for realtime queries. This does not need to be the same DataSet that the tree was fitted against, but does need to have matching labels. Using this mechanism, we have a way to, e.g. associate labels with segments of playback buffers, without needing pass strings around.
+messages:
   fit:
    description: |
       Build the tree by scanning the points of a :fluid-obj:`DataSet`
diff --git a/doc/LabelSet.yaml b/doc/LabelSet.yaml
@@ -9,15 +9,15 @@
 digest: A set of labels associated with IDs
 sc-categries: FluidManipulation
 sc-related: Classes/FluidDataSet, Classes/FluidKMeans
-see-also: 
+see-also:
 description: |
-  FluidLabelSet is a server-side container of associations between labels (from a :fluid-obj:`DataSet`) and IDs, for instance from some clustering or classification of the points in a data set.
+  FluidLabelSet is a container of associations between labels (from a :fluid-obj:`DataSet`) and IDs, for instance from some clustering or classification of the points in a data set.
 
 parameters:
   name:
     description: |
       symbol with the label set's name.
-messages: 
+messages:
   addLabel:
    description: |
       Add a label to the label set.
diff --git a/doc/Loudness.yaml b/doc/Loudness.yaml
@@ -14,7 +14,7 @@ description: Two loudness descriptors, with a ITU BS 1770 mode
 discussion: |
   Computes the true peak of the signal as well as applying the filters proposed by broadcasting standards to emulate the perception of amplitude.
 
-  The process will return a multichannel control steam with [loudness, truepeak] values, both in dBfs, which will be repeated if no change happens within the algorithm, i.e. when the hopSize is larger than the server's kr period. More information on broadcasting standardisation of loudness measurement is available at the reference page (https://tech.ebu.ch/docs/tech/tech3341.pdf) and in more musician-friendly explantions here (http://designingsound.org/2013/02/06/loudness-and-metering-part-1/).
+  The process will return a multichannel control steam with [loudness, truepeak] values, both in dBfs, which will be repeated if no change happens within the algorithm, i.e. when the hopSize is larger than the signal vector size. More information on broadcasting standardisation of loudness measurement is available at the reference page (https://tech.ebu.ch/docs/tech/tech3341.pdf) and in more musician-friendly explantions here (http://designingsound.org/2013/02/06/loudness-and-metering-part-1/).
 process: The audio rate in, control rate out version of the object.
 parameters:
   in:
@@ -28,7 +28,7 @@ parameters:
       A flag to switch the computation of TruePeak. On by default, removing it makes the algorithm more CPU efficient by reverting to a simple absolute peak of the frame.
   windowSize:
     description: |
-         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. 
+         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.
   hopSize:
     description: |
          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.
diff --git a/doc/MelBands.yaml b/doc/MelBands.yaml
@@ -14,7 +14,7 @@ description: Amplitude for a number of equally spread perceptual bands.
 discussion: |
   The spread is based on the Mel scale (https://en.wikipedia.org/wiki/Mel_scale) which was one of the first attempts to mimic pitch perception scientifically. This implementation allows to select the range and number of bands dynamically.
 
-  The process will return a multichannel control steam of size maxNumBands, which will be repeated if no change happens within the algorithm, i.e. when the hopSize is larger than the server's kr period.
+  The process will return a multichannel control steam of size maxNumBands, which will be repeated if no change happens within the algorithm, i.e. when the hopSize is larger than the signal vector size.
 process: The audio rate in, control rate out version of the object.
 parameters:
   in:
diff --git a/doc/NMFFilter.yaml b/doc/NMFFilter.yaml
@@ -26,7 +26,7 @@ parameters:
     description: The signal input to the factorisation process.
   bases:
     description: |
-      The server index of the buffer containing the different bases that the input signal will be matched against. Bases must be (fft size / 2) + 1 frames. If the buffer has more than maxComponents channels, the excess will be ignored.
+      The buffer containing the different bases that the input signal will be matched against. Bases must be (fft size / 2) + 1 frames. If the buffer has more than maxComponents channels, the excess will be ignored.
   maxComponents:
     description: |
       The maximum number of elements the NMF algorithm will try to divide the spectrogram of the source in. This dictates the number of output channels for the ugen. This cannot be modulated.
diff --git a/doc/NMFMatch.yaml b/doc/NMFMatch.yaml
@@ -28,7 +28,7 @@ parameters:
       The signal input to the factorisation process.
   bases:
     description: |
-      The server index of the buffer containing the different bases that the input signal will be matched against. Bases must be (fft size / 2) + 1 frames. If the buffer has more than maxComponents channels, the excess will be ignored.
+      The buffer containing the different bases that the input signal will be matched against. Bases must be (fft size / 2) + 1 frames. If the buffer has more than maxComponents channels, the excess will be ignored.
   maxComponents:
     description: The maximum number of elements the NMF algorithm will try to divide the spectrogram of the source in. This dictates the number of output channelsfor the ugen. This cannot be modulated.
   iterations:
diff --git a/doc/Normalize.yaml b/doc/Normalize.yaml
@@ -9,9 +9,9 @@
 digest: Normalize a FluidDataSet
 sc-categries: FluidManipulation
 sc-related: Classes/FluidStandardize, Classes/FluidDataSet
-see-also: 
+see-also:
 description: |
-  Normalize the entries of a :fluid-obj:`DataSet`, or normalize a data point according to the learned bounds of a data set. On the server.
+  Normalize the entries of a :fluid-obj:`DataSet`, or normalize a data point according to the learned bounds of a data set.
 
   See http://www.faqs.org/faqs/ai-faq/neural-nets/part2/section-16.html
 
@@ -25,7 +25,7 @@ parameters:
   invert:
     description: |
       The direction in which the normalization will occur for transform and transformpoint. The default 0 is taking in the range of the input used to fit and transforms it towards the normalised range. A value of 1 will expect an input of the normalized range to transform back to the original range.
-messages: 
+messages:
   fit:
    description: |
       Compute the normalization factors from a :fluid-obj:`DataSet` for later.
diff --git a/doc/Pitch.yaml b/doc/Pitch.yaml
@@ -11,7 +11,7 @@ sc-categories: Libraries>FluidDecomposition
 sc-related: Guides/FluCoMa, Guides/FluidDecomposition, Classes/Pitch
 see-also: BufPitch, MFCC, MelBands, Loudness, SpectralShape
 description: Three popular pitch descriptors, computed as frequency and the confidence in its value.
-discussion: The process will return a multichannel control steam with [pitch, confidence] values, which will be repeated if no change happens within the algorithm, i.e. when the hopSize is larger than the server's kr period. A pitch of 0 Hz is yield (or -999.0 when the unit is in MIDI note) when the algorithm cannot find a fundamental at all.
+discussion: The process will return a multichannel control steam with [pitch, confidence] values, which will be repeated if no change happens within the algorithm, i.e. when the hopSize is larger than the signal vector size. A pitch of 0 Hz is yield (or -999.0 when the unit is in MIDI note) when the algorithm cannot find a fundamental at all.
 process: The audio rate in, control rate out version of the object.
 parameters:
   in:
diff --git a/doc/RobustScale.yaml b/doc/RobustScale.yaml
@@ -11,7 +11,7 @@ sc-categries: FluidManipulation
 sc-related: Classes/FluidStandardize, Classes/FluidNormalize, Classes/FluidDataSet
 see-also:
 description: |
-  Scales the entries of a FluidDataSet, or scales a data point according to the learned values of a data set. It will centre the median of each dimension to 0, and will scale the data to +/- the provided centiles, by default providing the first and third qartile (25 and 75).All happens on the server.
+  Scales the entries of a FluidDataSet, or scales a data point according to the learned values of a data set. It will centre the median of each dimension to 0, and will scale the data to +/- the provided centiles, by default providing the first and third qartile (25 and 75).
 
   See https://scikit-learn.org/stable/auto_examples/preprocessing/plot_all_scaling.html#robustscaler
 
diff --git a/doc/SpectralShape.yaml b/doc/SpectralShape.yaml
@@ -26,7 +26,7 @@ discussion: |
 
   The drawings in Peeters 2003 (http://recherche.ircam.fr/anasyn/peeters/ARTICLES/Peeters_2003_cuidadoaudiofeatures.pdf) are useful, as are the commented examples below. For the mathematically-inclined reader, the tutorials and code offered here (https://www.audiocontentanalysis.org/) are interesting to further the understanding. For examples of the impact of computing the moments in power magnitudes, and/or in exponential frequency scale, please refer to the helpfile.
 
-  The process will return a multichannel control steam with the seven values, which will be repeated if no change happens within the algorithm, i.e. when the hopSize is larger than the server's kr period.
+  The process will return a multichannel control steam with the seven values, which will be repeated if no change happens within the algorithm, i.e. when the hopSize is larger than the signal vector size.
 process: The audio rate in, control rate out version of the object.
 parameters:
   in:
