Documentation Fix (#85)

- Minimum depth required for Drain is 3 however documentation says 2.
logpai · Aug 31, 2023 · 76d12de · 76d12de
1 parent 43076b7
commit 76d12de
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -122,7 +122,7 @@ Primary configuration parameters:
 
 - `[DRAIN]/sim_th` - similarity threshold. if percentage of similar tokens for a log message is below this number, a new
   log cluster will be created (default 0.4)
-- `[DRAIN]/depth` - max depth levels of log clusters. Minimum is 2. (default 4)
+- `[DRAIN]/depth` - max depth levels of log clusters. Minimum is 3. (default 4)
 - `[DRAIN]/max_children` - max number of children of an internal node (default 100)
 - `[DRAIN]/max_clusters` - max number of tracked clusters (unlimited by default). When this number is reached, model
   starts replacing old clusters with a new ones according to the LRU cache eviction policy.

diff --git a/drain3/drain.py b/drain3/drain.py
@@ -62,7 +62,7 @@ def __init__(self,
         """
         Create a new Drain instance.
 
-        :param depth: max depth levels of log clusters. Minimum is 2.
+        :param depth: max depth levels of log clusters. Minimum is 3.
             For example, for depth==4, Root is considered depth level 1.
             Token count is considered depth level 2.
             First log token is considered depth level 3.