Merge pull request #385 from charan-teja2003/main

ARWithConfidence
UdayLab · Apr 23, 2024 · 1b189f1 · 1b189f1
2 parents 588b78a + 62bd190
commit 1b189f1
Showing 1 changed file with 13 additions and 37 deletions.
diff --git a/PAMI/AssociationRules/basic/ARWithConfidence.py b/PAMI/AssociationRules/basic/ARWithConfidence.py
@@ -3,7 +3,6 @@
 # **Importing this algorithm into a python program**
 # ----------------------------------------------------
 #
-#
 #             import PAMI.AssociationRules.basic import ARWithConfidence as alg
 #
 #             obj = alg.ARWithConfidence(iFile, minConf)
@@ -33,8 +32,6 @@
 
 
 
-
-
 __copyright__ = """
 Copyright (C)  2021 Rage Uday Kiran
 
@@ -54,14 +51,9 @@
      
 """
 
-
-
-
 from PAMI.AssociationRules.basic import abstract as _ab
 from deprecated import deprecated
 
-
-
 class _Confidence:
     """
     :param  patterns: Dictionary containing patterns and its support value.
@@ -144,37 +136,20 @@ class ARWithConfidence:
     About this algorithm
     ====================
 
-    :Description: Association Rules are derived from frequent patterns using "confidence" metric.
+    :**Description**: Association Rules are derived from frequent patterns using "confidence" metric.
 
-    :Reference:
+    :**Reference**:
 
-    :param  iFile: str :
-                   Name of the Input file to mine complete set of association rules
-    :param  oFile: str :
-                   Name of the output file to store complete set of association rules
-    :param  minConf: float :
-                   The user can specify the minConf in float between the range of 0 to 1.
-    :param  sep: str :
-                   This variable is used to distinguish items from one another in a transaction. The default seperator is tab space. However, the users can override their default separator.
+    :**Parameters**:    - **iFile** (*str*) -- *Name of the Input file to mine complete set of association rules*
+                        - **oFile** (*str*) -- *Name of the Output file to write association rules*
+                        - **minConf** (*float*) -- *Minimum confidence to mine all the satisfying association rules. The user can specify the minConf in float between the range of 0 to 1.*
+                        - **sep** (*str*) -- *This variable is used to distinguish items from one another in a transaction. The default seperator is tab space. However, the users can override their default separator.*
 
-
-        
-    :Attributes:
-
-        startTime : float
-            To record the start time of the mining process
-
-        endTime : float
-            To record the completion time of the mining process
-
-        finalPatterns : dict
-            Storing the complete set of patterns in a dictionary variable
-
-        memoryUSS : float
-            To store the total amount of USS memory consumed by the program
-
-        memoryRSS : float
-            To store the total amount of RSS memory consumed by the program
+    :**Attributes**:    - **startTime** (*float*) -- *To record the start time of the mining process.*
+                        - **endTime** (*float*) -- *To record the completion time of the mining process.*
+                        - **finalPatterns** (*dict*) -- *Storing the complete set of patterns in a dictionary variable.*
+                        - **memoryUSS** (*float*) -- *To store the total amount of USS memory consumed by the program.*
+                        - **memoryRSS** (*float*) -- *To store the total amount of RSS memory consumed by the program.*
 
 
     Execution methods
@@ -229,7 +204,8 @@ class ARWithConfidence:
     Credits
     =======
 
-            The complete program was written by P.Likhitha  under the supervision of Professor Rage Uday Kiran.
+            The complete program was written by P. Likhitha  under the supervision of Professor Rage Uday Kiran.
+
     """
 
     _minConf = float()