Added some documentation

osopardo1 · Dec 11, 2023 · 3c8c918 · 3c8c918
1 parent cf93459
commit 3c8c918
Showing 1 changed file with 16 additions and 0 deletions.
diff --git a/docs/AutoIndexer.md b/docs/AutoIndexer.md
@@ -0,0 +1,16 @@
+SparkAutoIndexer
+
+SparkAutoIndexer is designed to work with Apache Spark DataFrames and provides functionality to automatically select columns for indexing based on certain criteria.
+
+    chooseColumnsToIndex(data: DataFrame): Seq[String]
+        Description: Chooses columns to index from the given DataFrame without limiting the number of columns.
+        Parameters:
+            data: DataFrame - The DataFrame from which columns are selected for indexing.
+        Returns: Seq[String] - A sequence of column names selected for indexing.
+
+    chooseColumnsToIndex(data: DataFrame, numColumnsToIndex: Int): Seq[String]
+        Description: Chooses a specified number of columns to index from the given DataFrame.
+        Parameters:
+            data: DataFrame - The DataFrame from which columns are selected for indexing.
+            numColumnsToIndex: Int - The number of columns to index.
+        Returns: Seq[String] - A sequence of column names selected for indexing.