Merge pull request flucoma#10 from jamesb93/main

James Bradbury · web-flow · commit bc7cc6b9f4f2 · 2021-09-15T13:50:43.000+01:00
Fix many issues to do with identifier/label and word usage in regards to key/value associations.
diff --git a/doc/AudioTransport.yaml b/doc/AudioTransport.yaml
@@ -7,7 +7,7 @@
 # (grant agreement No 725899).
 ---
 digest: Interpolate between sounds
-sc-categries: FluidManipulation
+sc-categories: FluidManipulation
 sc-related: Classes/FluidBufAudioTransport
 see-also: 
 description: |
diff --git a/doc/BufAudioTransport.yaml b/doc/BufAudioTransport.yaml
@@ -7,7 +7,7 @@
 # (grant agreement No 725899).
 ---
 digest: Interpolate between buffers
-sc-categries: FluidManipulation
+sc-categories: FluidManipulation
 sc-related: Classes/FluidAudioTransport
 see-also: 
 description: |
diff --git a/doc/BufFlatten.yaml b/doc/BufFlatten.yaml
@@ -7,7 +7,7 @@
 # (grant agreement No 725899).
 ---
 digest: Flatten a multichannel buffer
-sc-categries: FluidCorpusManipulation
+sc-categories: FluidCorpusManipulation
 sc-related: Classes/Buffer
 see-also:
 description: |
diff --git a/doc/BufMFCC.yaml b/doc/BufMFCC.yaml
@@ -7,7 +7,7 @@
 # (grant agreement No 725899).
 ---
 digest: Mel-Frequency Cepstral Coefficients as Spectral Descriptors on a Buffer
-sc-categries: Libraries>FluidDecomposition
+sc-categories: Libraries>FluidDecomposition
 sc-related: Guides/FluCoMa, Guides/FluidDecomposition, Guides/FluidBufMultiThreading, Classes/FluidBufMelBands
 see-also:
 description: |
diff --git a/doc/BufNMFCross.yaml b/doc/BufNMFCross.yaml
@@ -7,7 +7,7 @@
 # (grant agreement No 725899).
 ---
 digest: Resynthesise a target sound based on a source sound
-sc-categries: FluidManipulation
+sc-categories: FluidManipulation
 sc-related: Classes/FluidBufNMF, Classes/FluidNMFMatch, Classes/FluidNMFFilter
 see-also: 
 description: Reconstructs the sound in the target buffer using components learned from the source buffer using an NMF decomposition 
diff --git a/doc/BufNNDSVD.yaml b/doc/BufNNDSVD.yaml
@@ -7,7 +7,7 @@
 # (grant agreement No 725899).
 ---
 digest: Non-Negative Double Singular Value Decomposition on a Buffer
-sc-categries: FluidManipulation
+sc-categories: FluidManipulation
 sc-related: Classes/FluidBufNMF
 see-also: 
 description: |
diff --git a/doc/BufSTFT.yaml b/doc/BufSTFT.yaml
@@ -7,7 +7,7 @@
 # (grant agreement No 725899).
 ---
 digest: Perform a Short-Time Fourier Transform on one channel of a buffer
-sc-categries: FluidCorpusManipulation
+sc-categories: FluidCorpusManipulation
 sc-related: Classes/Buffer
 see-also:
 description: |
diff --git a/doc/BufScale.yaml b/doc/BufScale.yaml
@@ -7,7 +7,7 @@
 # (grant agreement No 725899).
 ---
 digest: A Scaling Processor for Buffers
-sc-categries: Libraries>FluidDecomposition
+sc-categories: Libraries>FluidDecomposition
 sc-related: Guides/FluCoMa, Guides/FluidDecomposition, Guides/FluidBufMultiThreading
 see-also:
 description: |
diff --git a/doc/BufSelect.yaml b/doc/BufSelect.yaml
@@ -7,7 +7,7 @@
 # (grant agreement No 725899).
 ---
 digest: Cherry pick values from a buffer
-sc-categries: FluidCorpusManipulation
+sc-categories: FluidCorpusManipulation
 sc-related: Classes/Buffer
 see-also: BufSelectEvery
 description: |
diff --git a/doc/BufSelectEvery.yaml b/doc/BufSelectEvery.yaml
@@ -7,7 +7,7 @@
 # (grant agreement No 725899).
 ---
 digest: Extract every N samples / channels from a buffer
-sc-categries: FluidCorpusManipulation
+sc-categories: FluidCorpusManipulation
 sc-related: Classes/Buffer
 see-also: BufSelect
 description: |
diff --git a/doc/BufThresh.yaml b/doc/BufThresh.yaml
@@ -7,7 +7,7 @@
 # (grant agreement No 725899).
 ---
 digest: A Gate Processor for Buffers
-sc-categries: Libraries>FluidDecomposition
+sc-categories: Libraries>FluidDecomposition
 sc-related: Guides/FluCoMa, Guides/FluidDecomposition, Guides/FluidBufMultiThreading
 see-also:
 description: |
diff --git a/doc/DataSet.yaml b/doc/DataSet.yaml
@@ -11,69 +11,69 @@ sc-categories: UGens>FluidManipulation
 sc-related: Classes/FluidLabelSet, Classes/FluidKDTree, Classes/FluidKNN, Classes/FluidKMeans
 see-also:
 description: |
-  FluidDataSet is a container associating identifiers with data.
+  FluidDataSet is a container associating data points with identifiers.
 
 parameters:
   name:
     description: |
-      Symbol with the name of the DataSet. ​
+      The name of the FluidDataSet. This is unique between all FluidDataSets.
 
 messages:
   addPoint:
    description: |
-      Add a new point to the data set. The dimensionality of the DataSet is governed by the size of the first point added. Will report an error if the identifier already exists, or if the size of the data does not match the dimensionality of the DataSet.
+      Add a new point to the FluidDataSet. The dimensionality of the FluidDataSet is governed by the size of the first point added. If the identifier already exists, or if the size of the data does not match the dimensionality of the FluidDataSet an error will be reported.
    args:
     - name: identifier
       description: |
-        A symbol or string with the identifier for the new point.
+        The identifier for the point.
     - name: buffer
       description: |
-        A |buffer| with the new data point.
+        A |buffer| containing the data for the point.
     - name: action
       description: |
         A function to run when the point has been added.
          ​​
   updatePoint:
    description: |
-      Update an existing identifier's data. Will report an error if the identifier doesn't exist, or if the size of the data does not match the given dimensionality of the DataSet.
+      Update an existing identifier's data. If the identifier does not exist, or if the size of the data does not match the dimensionality of the FluidDataSet an error will be reported.
    args:
     - name: identifier
       description: |
-        Symbol or string with the identifier for this point.
+        The identifier for this point.
     - name: buffer
       description: |
-        A |buffer| with the new data point.
+        A |buffer| containing the data for the point.
 
   getPoint:
    description: |
-      Retrieve a point from the data set into a |buffer|. Will report an error if the identifier or buffer does not exist​.
+      Retrieve a point from the data set into a |buffer|. If the identifier does not exist an error will be reported.
    args:
     - name: identifier
       description: |
-        Symbol or string with the identifier for the point to be retrieved.
+        The identifier for the point to be retrieved.
     - name: buffer
       description: |
-        A |buffer| where the associated data will be stored.
+        A |buffer| where the retrieved data will be stored.
 
   deletePoint:
    description: |
-      Remove a point from the data set. Will report an error if the identifier doesn't exist. ​​
+      Remove a point from the data set. If the identifier doesn't exist an error will be reported. ​​
    args:
     - name: identifier
       description: |
-        Symbol or string with the identifier to be deleted.
+        The identifier to be deleted.
 
   setPoint:
    description: |
-    Set the point: if the identifier exists, this method behaves like updatePoint; if the identifier doesn't exist, behaves like addPoint.
+    Set the point. If the identifier exists, this method behaves like updatePoint. If the identifier doesn't exist, it behaves like addPoint.
    args:
     - name: identifier
       description: |
-        Symbol or string with the identifier for this point.
+        The identifier for this point.
       
     - name: buffer
       description: |
-        A |buffer| containing the new data for the point.
+        A |buffer| containing the data for the point.
 
   clear:
    description: |
@@ -113,14 +113,14 @@ messages:
         A function to run when the point has been added.
   getIds:
    description: |
-    Export to the dataset IDs to a FluidLabelSet.
+    Export to the dataset identifier to a FluidLabelSet.
    args:
     - name: labelSet
       description: |
         The FluidLabelSet to export to. Its content will be replaced.
     - name: action
       description: |
-        A function to run when the point has been added.
+        A function to run when the export is done.
   merge:
    description: |
       Merge sourceDataSet in the current DataSet. It will update the value of points with the same identifier if overwrite is set to 1. ​To add columns instead, see the 'transformJoin' method of FluidDataSetQuery.
@@ -140,5 +140,5 @@ messages:
    args:
   server:
    description: |
-      The server instance the object uses ​
+      The server instance the object uses .
    args:
diff --git a/doc/DataSetQuery.yaml b/doc/DataSetQuery.yaml
@@ -7,7 +7,7 @@
 # (grant agreement No 725899).
 ---
 digest: Query a FluidDataSet
-sc-categries: UGens>FluidManipulation
+sc-categories: UGens>FluidManipulation
 sc-related: Classes/FluidDataSet
 see-also: 
 description: |
@@ -117,7 +117,7 @@ messages:
         Run when done
   transformJoin:
    description: |
-      Apply the query to a source FluidDataSet and join the resulting subset at the end of the items sharing the same labels in a second source. Items unique to a source dataset will be ignored. To add items at the end of a dataset instead, see the 'merge' method of FluidDataSet.
+      Apply the query to a source FluidDataSet and join the resulting subset at the end of the items sharing the same identifiers in a second source. Items unique to a source dataset will be ignored. To add items at the end of a dataset instead, see the 'merge' method of FluidDataSet.
   args:
     - name: source1DataSet
       description: |
diff --git a/doc/KDTree.yaml b/doc/KDTree.yaml
@@ -7,7 +7,7 @@
 # (grant agreement No 725899).
 ---
 digest: KD Tree
-sc-categries: FluidManipulation
+sc-categories: FluidManipulation
 sc-related: Classes/FluidDataSet
 see-also:
 description: |
diff --git a/doc/KMeans.yaml b/doc/KMeans.yaml
@@ -7,7 +7,7 @@
 # (grant agreement No 725899).
 ---
 digest: Cluster data points with K-Means
-sc-categries: FluidManipulation
+sc-categories: FluidManipulation
 sc-related: Classes/FluidDataSet, Classes/FluidLabelSet, Classes/FluidKNNClassifier, Classes/FluidKNNRegressor
 see-also:
 description: |
diff --git a/doc/KNNClassifier.yaml b/doc/KNNClassifier.yaml
@@ -7,7 +7,7 @@
 # (grant agreement No 725899).
 ---
 digest: Classify data with K Nearest Neighbours
-sc-categries: Classification, KNN
+sc-categories: Classification, KNN
 sc-related: Classes/FluidKNNRegressor, Classes/FluidDataSet, Classes/FluidLabelSet
 see-also: 
 description: |
diff --git a/doc/KNNRegressor.yaml b/doc/KNNRegressor.yaml
@@ -7,7 +7,7 @@
 # (grant agreement No 725899).
 ---
 digest: Regression with K Nearest Neighbours
-sc-categries: Regression
+sc-categories: Regression
 sc-related: Classes/FluidKNNClassifier, Classes/FluidDataSet
 see-also: 
 description: |
diff --git a/doc/LabelSet.yaml b/doc/LabelSet.yaml
@@ -7,11 +7,11 @@
 # (grant agreement No 725899).
 ---
 digest: A set of labels associated with identifiers.
-sc-categries: FluidManipulation
+sc-categories: FluidManipulation
 sc-related: Classes/FluidDataSet, Classes/FluidKMeans
 see-also: DataSet, DataSetQuery
 description: |
-  FluidLabelSet is a container of associating identifiers with labels.
+  FluidLabelSet is a container associating identifiers with labels.
 
 parameters:
   name:
@@ -24,51 +24,51 @@ messages:
    args:
     - name: identifier
       description: |
-        Symbol or string with the identifier for this label.
+        The identifier for this label.
     - name: label
       description: |
-        Symbol or string with the label to add.
+        The label to add.
     - name: action
       description: |
-        Function to run when the operation completes.
+        A function to run when the operation completes.
         
   updateLabel:
    description: |
       Update a label for a given identifier in the label set.
    args:
     - name: identifier
       description: |
-        Symbol or string with the identifier for this label.
+        The identifier for this label.
     - name: label
       description: |
-        Symbol or string with the label to update. 
+        The label to update. 
 
   setLabel:
    description: |
       Set a label for a given identifier.
    args:
     - name: identifier
       description: |
-        Symbol or string with the identifier for this label.
+        The identifier for this label.
     - name: label
       description: |
-        Symbol or string with the label to update.
+        The label to update.
 
   getLabel:
    description: |
       Retrieve the label associated with an identifier. Will report an error if the identifier is not present in the set.
    args:
     - name: identifier
       description: |
-        Symbol or string with the identifier for the label to be retrieved.
+        The identifier for the label to be retrieved.
 
   deleteLabel:
    description: |
-      Delete a identifier-label pair.
+      Delete a label given a certain identifier.
    args:
     - name: identifier
       description: | 
-        Symbol or string with the identifier to be deleted.
+        The identifier to be deleted.
   clear:
    description: |
       Empty the label set and reset to a clean state.
diff --git a/doc/MDS.yaml b/doc/MDS.yaml
@@ -7,7 +7,7 @@
 # (grant agreement No 725899).
 ---
 digest: Dimensionality Reduction with Multidimensional Scaling
-sc-categries: Dimensionality Reduction, Data Processing
+sc-categories: Dimensionality Reduction, Data Processing
 sc-related: Classes/FluidMDS, Classes/FluidDataSet
 see-also: 
 description: |
diff --git a/doc/MLPClassifier.yaml b/doc/MLPClassifier.yaml
@@ -7,7 +7,7 @@
 # (grant agreement No 725899).
 ---
 digest: Classification with a multi-layer perceptron
-sc-categries: Machine learning
+sc-categories: Machine learning
 sc-related: Classes/FluidMLPRegressor, Classes/FluidDataSet
 see-also: 
 description: |
diff --git a/doc/MLPRegressor.yaml b/doc/MLPRegressor.yaml
@@ -7,7 +7,7 @@
 # (grant agreement No 725899).
 ---
 digest: Regression with a multi-layer perceptron
-sc-categries: Machine learning
+sc-categories: Machine learning
 sc-related: Classes/FluidMLPClassifier, Classes/FluidDataSet
 see-also: 
 description: |
diff --git a/doc/NMFMorph.yaml b/doc/NMFMorph.yaml
@@ -7,7 +7,7 @@
 # (grant agreement No 725899).
 ---
 digest: Morph between sounds
-sc-categries: FluidCorpusManipulation
+sc-categories: FluidCorpusManipulation
 sc-related: Classes/FluidAudioTransport, Classes/FluidBufNMFCross
 see-also: 
 description: |
diff --git a/doc/Normalize.yaml b/doc/Normalize.yaml
@@ -7,7 +7,7 @@
 # (grant agreement No 725899).
 ---
 digest: Normalize a FluidDataSet
-sc-categries: FluidManipulation
+sc-categories: FluidManipulation
 sc-related: Classes/FluidStandardize, Classes/FluidDataSet
 see-also:
 description: |
diff --git a/doc/PCA.yaml b/doc/PCA.yaml
@@ -7,7 +7,7 @@
 # (grant agreement No 725899).
 ---
 digest: Dimensionality Reduction with Principal Component Analysis
-sc-categries: Dimensionality Reduction, Data Processing
+sc-categories: Dimensionality Reduction, Data Processing
 sc-related: Classes/FluidMDS, Classes/FluidDataSet
 see-also:
 description: |
diff --git a/doc/RobustScale.yaml b/doc/RobustScale.yaml
diff --git a/doc/Standardize.yaml b/doc/Standardize.yaml
diff --git a/doc/UMAP.yaml b/doc/UMAP.yaml
