Added comment for sort export

Christoph · Nov 13, 2020 · 9c30b60 · 9c30b60
1 parent 966ca34
commit 9c30b60
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/robics/robust_topics.py b/robics/robust_topics.py
@@ -334,6 +334,15 @@ def export_model(self, model_id, sample_id, run_id):
 
     def export_topic_sort_indices(self, model_id, sample_id, run_id):
         """ Returns the sort indices for a specific model instance
+
+        Parameters
+        ----------
+        model_id : int
+            The array index of the model.
+        sample_id : int
+            The array index of the sample within the selected model.
+        initialization_id : int
+            The array index of the initialization of respective sample and model.
         """
 
         indices = self.models[model_id].topic_sorting_indices[sample_id][run_id]