Sol pipelines #387
Sol pipelines #387
Conversation
…to SOL-pipelines
…to SOL-pipelines
|
|
There was a problem hiding this comment.
Great PR @MihirT906!
Couple of small things need to be fixed (mainly docstrings)
Please remove the changes of the following files:
2'(I think it was added by mistake)Makefiletests/readme_test/README.mdtests/readme_test/README_evaluate.md
| """ | ||
| The function checks if the dataset being used is valid i.e has a length greater than 0 and contains the dimension required | ||
| Args: | ||
| X (ndarray): | ||
| N-dimensional value sequence to iterate over | ||
| dim (int): | ||
| Integer indicating the dimension number for a multi-dimensional dataset | ||
| Returns: | ||
| ndarray: | ||
| Returns an nd array that contains a dataset with 2 columns ['timestamp', 'value'] | ||
|
|
||
| """ |
There was a problem hiding this comment.
There are a couple of things to keep in mind when writing docstrings. The most important thing is to be consistent with the existing docstrings which should look something like this
"""Short description in a single line ending with a dot.
Longer description that can span across multiple lines. Longer
description that can span across multiple lines. Longer description
that can span across multiple lines.
Args:
arg_name (arg_type):
argument description.
arg_name (arg_type):
Argument description that spans across multiple lines. Argument
description that spans across multiple lines. Argument description
that spans across multiple lines.
Returns:
return_type:
description of the returned objects
Based on the current code, what needs to be fixed is:
- the first sentence is always short
- if the line is longer than 100 characters, break it over multiple lines
- add space between each section (
Args:, andReturns:) - lastly remove unnecessary white space (line 22)
Applying all these changes would look something like:
"""Validate data dimensions.
The function checks if the dataset being used is valid i.e has a length
greater than 0 and contains the dimension required.
Args:
X (ndarray):
N-dimensional value sequence to iterate over.
dim (int):
Integer indicating the dimension number for a multi-dimensional dataset.
Returns:
ndarray:
An array that contains a dataset with 2 columns ['timestamp', 'value'].
"""
This applies to all the docstrings
|
|
||
| def diff_thres(X, thres = "0.1", op = ">"): | ||
| """ | ||
| The function detects anomalies that are flagged through moving standard deviation thresholding |
There was a problem hiding this comment.
I think the description here is inaccurate
|
|
||
| def thresholding(X, thres, op): | ||
| """ | ||
| The function detects anomalies that are flagged through moving standard deviation thresholding |
There was a problem hiding this comment.
similarly here, I think it needs to be updated
| @@ -0,0 +1,31 @@ | |||
| { | |||
There was a problem hiding this comment.
I noticed build_anomaly_intervals is not being used. Is there a reason for adding it to the PR? (similar comment applies to the function, if it is not part of the pipelines, we can remove it)
Resolve #355