Skip to content

Commit f5c078a

Browse files
committed
added more description on the process method parameters.
Signed-off-by: Kaituo Li <[email protected]>
1 parent 869a974 commit f5c078a

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

python_rcf_wrapper/trcf_model.py

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,8 @@ def __init__(self, rcf_dimensions, shingle_size, num_trees: int = 30, output_aft
4040

4141
def process(self, point: List[float]) -> AnomalyDescriptor:
4242
"""
43-
Compute an anomaly score for the given point.
43+
a single call that prepreprocesses data, compute score/grade and updates
44+
state.
4445
4546
Parameters
4647
----------
@@ -49,8 +50,9 @@ def process(self, point: List[float]) -> AnomalyDescriptor:
4950
5051
Returns
5152
-------
52-
float
53-
The anomaly score for the given point
53+
AnomalyDescriptor
54+
Encapsulate detailed information about anomalies detected by RCF model. This class stores various attributes
55+
related to an anomaly, such as confidence levels, attribution scores, and expected values.
5456
5557
"""
5658
return self.forest.process(point, 0)

0 commit comments

Comments
 (0)