Update MixtureFactory_doc.i.in

Document BuildClusters
openturns · Jun 14, 2024 · 817f266 · 817f266
1 parent feb501a
commit 817f266
Showing 1 changed file with 20 additions and 0 deletions.
diff --git a/python/src/MixtureFactory_doc.i.in b/python/src/MixtureFactory_doc.i.in
@@ -104,3 +104,23 @@ Returns
 atomsNumber : int
     The number of atoms
 "
+
+// ----------------------------------------------------------------------------
+
+%feature("docstring") OTMIXMOD::MixtureFactory::BuildClusters
+"Partition a given sample into nbClusters according to the given labels.
+
+Parameters
+----------
+data : ot.Sample(size, dimension)
+    The sample
+labels : ot.Indices(size)
+    The index of the class of each point in the sample
+nbClusters : int
+    The number of clusters in the mixture
+
+Returns
+-------
+clusters : list of ot.Sample
+    The list of samples corresponding to each class
+"