Fixed documentation for sampling_ratio option (#873)

* Add documentation for `sampling_ratio` option * Update `sample_ratio` to `sampling_ratio` in documentations Co-authored-by: Taylor Turner <taylorfturner@gmail.com> * Update `sampling_ratio` documentation Co-authored-by: Taylor Turner <taylorfturner@gmail.com> * Update `sampling_ratio` documentation * Updated `sampling_ratio` documentation * Updated `sampling_ratio` documentation * Updated `sampling_ratio` documentation --------- Co-authored-by: Taylor Turner <taylorfturner@gmail.com>
capitalone · Jun 15, 2023 · 4b41bcf · 4b41bcf
1 parent 8b8a0a2
commit 4b41bcf
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/docs/source/profiler.rst b/docs/source/profiler.rst
@@ -627,6 +627,9 @@ Below is an breakdown of all the options.
     * **multiprocess** - Option to enable multiprocessing. Automatically selects the optimal number of processes to utilize based on system constraints.
 
       * is_enabled - (Boolean) Enables or disables multiprocessing
+      
+    * **sampling_ratio** - A percentage, as a decimal, ranging from greater than 0 to less than or equal to 1 indicating how much input data to sample. Default value set to 0.2.
+    
     * **int** - Options for the integer columns
 
       * is_enabled - (Boolean) Enables or disables the integer operations