From 3014a29bffc213783115f8dc5989fcd6f93db9e0 Mon Sep 17 00:00:00 2001 From: Tibor Reiss Date: Thu, 12 Sep 2024 20:28:34 +0200 Subject: [PATCH] Make docs clearer --- docs/docs/how_to/semantic-chunker.ipynb | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/docs/how_to/semantic-chunker.ipynb b/docs/docs/how_to/semantic-chunker.ipynb index b59375c022f5b6..87f80359b0c3d5 100644 --- a/docs/docs/how_to/semantic-chunker.ipynb +++ b/docs/docs/how_to/semantic-chunker.ipynb @@ -127,7 +127,7 @@ "\n", "### Percentile\n", "\n", - "The default way to split is based on percentile. In this method, all differences between sentences are calculated, and then any difference greater than the X percentile is split." + "The default way to split is based on percentile. In this method, all differences between sentences are calculated, and then any difference greater than the X percentile is split. The default value for X is 95.0 and can be adjusted by the keyword argument `breakpoint_threshold_amount` which expects a number between 0.0 and 100.0." ] }, { @@ -186,7 +186,7 @@ "source": [ "### Standard Deviation\n", "\n", - "In this method, any difference greater than X standard deviations is split." + "In this method, any difference greater than X standard deviations is split. The default value for X is 3.0 and can be adjusted by the keyword argument `breakpoint_threshold_amount`." ] }, { @@ -245,7 +245,7 @@ "source": [ "### Interquartile\n", "\n", - "In this method, the interquartile distance is used to split chunks." + "In this method, the interquartile distance is used to split chunks. The interquartile range can be scaled by the keyword argument `breakpoint_threshold_amount`, the default value is 1.5." ] }, { @@ -306,8 +306,8 @@ "source": [ "### Gradient\n", "\n", - "In this method, the gradient of distance is used to split chunks along with the percentile method.\n", - "This method is useful when chunks are highly correlated with each other or specific to a domain e.g. legal or medical. The idea is to apply anomaly detection on gradient array so that the distribution become wider and easy to identify boundaries in highly semantic data." + "In this method, the gradient of distance is used to split chunks along with the percentile method. This method is useful when chunks are highly correlated with each other or specific to a domain e.g. legal or medical. The idea is to apply anomaly detection on gradient array so that the distribution become wider and easy to identify boundaries in highly semantic data.\n", + "Similar to the percentile method, the split can be adjusted by the keyword argument `breakpoint_threshold_amount` which expects a number between 0.0 and 100.0, the default value is 95.0." ] }, {