[DOC] resolved the inconsistency of double ticks for the anomaly detection module #809 #2546

AnaghDeshpande · 2025-02-19T17:35:54Z

Reference Issues/PRs

#809

What does this implement/fix? Explain your changes.

This PR addresses the issue Inconsistent double tick quotes in docstrings #809.

In the anomaly_detection module i have changed all the double tick quotes to single tick quotes.

Does your contribution introduce a new dependency? If yes, which one?

Any other comments?

PR checklist

For all contributions

The PR title starts with either [ENH], [MNT], [DOC], [BUG], [REF], [DEP] or [GOV] indicating whether the PR topic is related to enhancement, maintenance, documentation, bugs, refactoring, deprecation or governance.

aeon-actions-bot · 2025-02-19T17:36:24Z

Thank you for contributing to `aeon`

I have added the following labels to this PR based on the title: [ $\color{#F3B9F8}{\textsf{documentation}}$ ].
I have added the following labels to this PR based on the changes made: [ $\color{#6F6E8D}{\textsf{anomaly detection}}$ ]. Feel free to change these if they do not properly represent the PR.

The Checks tab will show the status of our automated tests. You can click on individual test runs in the tab or "Details" in the panel below to see more information if there is a failure.

If our pre-commit code quality check fails, any trivial fixes will automatically be pushed to your PR unless it is a draft.

Don't hesitate to ask questions on the aeon Slack channel if you have any.

PR CI actions

These checkboxes will add labels to enable/disable CI functionality for this PR. This may not take effect immediately, and a new commit may be required to run the new configuration.

Run pre-commit checks for all files
Run mypy typecheck tests
Run all pytest tests and configurations
Run all notebook example tests
Run numba-disabled codecov tests
Stop automatic pre-commit fixes (always disabled for drafts)
Disable numba cache loading
Push an empty commit to re-run CI checks

SebastianSchmidl · 2025-02-19T19:25:56Z

Did I get the issue wrong, or is this PR transforming the quotes the wrong way around?

Single ticks render as italics while double ticks render as code in the api docs, e.g. int v.s. int.

I think double ticks is preferable

IMO, code references, such as class names, parameter names, and default values should, thus, be in double quotes: ``

AnaghDeshpande · 2025-02-20T05:50:18Z

Sorry for the mistake i will change it to double quotes.

made changes in line number 19 and 145.

made changes in line number 76

made changes in line number 19

made changes in line number 178

made changes in line number 215

made changes in line number 19

made changes in line number 165

made changes in line number 125

SebastianSchmidl · 2025-02-21T14:52:17Z

aeon/anomaly_detection/_cblof.py

-    ``window_size`` and ``stride``. The internal `X` has the shape
-    `(n_windows, window_size * n_channels)`.
+    Here, ``X`` refers to the set of sliding windows extracted from the time series
+    using :func:``aeon.utils.windowing.sliding_windows`` with the parameters


Directives must use single ticks; otherwise, they do not render correctly. Please revert to single ticks and also check other locations for this.

ok sure. will check sorry about the delay.

SebastianSchmidl · 2025-02-21T14:54:43Z

aeon/anomaly_detection/_cblof.py

-    the PyOD model ``CBLOF`` except for `window_size` and `stride`, which are used to
-    construct the sliding windows.
+    the PyOD model ``CBLOF`` except for ``window_size`` and ``stride``,
+    which are used to construct the sliding windows.

    The documentation for parameters has been adapted from the
    [PyOD documentation](https://pyod.readthedocs.io/en/latest/pyod.models.html#id117).


Because we are already working on the docs. Please also fix the link. This is Markdown syntax and not rst: https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#hyperlinks

Still does not render correctly: https://aeon-toolkit--2546.org.readthedocs.build/en/2546/api_reference/auto_generated/aeon.anomaly_detection.CBLOF.html#aeon.anomaly_detection.CBLOF

aeon/anomaly_detection/_cblof.py

aeon/anomaly_detection/_iforest.py

aeon/anomaly_detection/_left_stampi.py

aeon/anomaly_detection/_stomp.py

aeon/anomaly_detection/tests/test_stomp.py

MatthewMiddlehurst · 2025-02-25T11:01:43Z

Thanks Sebastian for the review. Please check how changes are rendered after you make them in the PR docs build https://aeon-toolkit--2546.org.readthedocs.build/en/2546/

…naghDeshpande/aeon into fix/inconsistent-double-quotes

SebastianSchmidl · 2025-02-26T09:11:11Z

aeon/anomaly_detection/_iforest.py

-            - If "auto", then ``max_samples=min(256, n_samples)``.
+            - If ``int``, then draw ``max_samples`` samples.
+            - If ``float``, then draw ``max_samples * X.shape[0]`` samples.
+            - If ``auto``, then ``max_samples=min(256, n_samples)``.


Suggested change

- If ``auto``, then ``max_samples=min(256, n_samples)``.

- If ``"auto"``, then ``max_samples=min(256, n_samples)``.

SebastianSchmidl · 2025-02-26T09:11:42Z

aeon/anomaly_detection/_iforest.py



    random_state : int, np.RandomState or None, default=None
-        If int, random_state is the seed used by the random number generator;
+        If ``int``, random_state is the seed used by the random number generator;
        If RandomState instance, random_state is the random number generator;
        If None, the random number generator is the RandomState instance used


Suggested change

If None, the random number generator is the RandomState instance used

If ``None``, the random number generator is the RandomState instance used

SebastianSchmidl · 2025-02-26T09:12:50Z

aeon/anomaly_detection/base.py

@@ -156,8 +156,9 @@ def predict(self, X, axis=1) -> np.ndarray:
        Returns
        -------
        np.ndarray
-            A boolean, int or float array of length len(X), where each element indicates
-            whether the corresponding subsequence is anomalous or its anomaly score.
+            A boolean, ``int`` or ``float`` array of length len(X), where each element


Why have int and float as code, but boolean not? Also len(X) is code

MatthewMiddlehurst · 2025-03-03T22:25:48Z

aeon/anomaly_detection/_cblof.py

+            ``MyClass(**params)`` or ``MyClass(**params[i])`` creates a valid test
+            instance. ``create_test_instance`` uses the first (or only) dictionary
+            in ``params``.


@SebastianSchmidl does it make sense for these to be here in the first place? It is private so not on the webpage, I'm just wondering if it formats ln intellisense as well or any other reason we would want this.

MatthewMiddlehurst · 2025-03-03T22:26:57Z

aeon/anomaly_detection/_one_class_svm.py

@@ -43,8 +43,8 @@ class OneClassSVM(BaseAnomalyDetector):

        - if ``gamma='scale'`` (default) is passed then it uses
          1 / (n_features * X.var()) as value of gamma,
-        - if 'auto', uses 1 / n_features
-        - if float, must be non-negative.
+        - if ``"auto"``, uses 1 / n_features


This is not the only one, but I'm not sure I agree to using both quotes " and ``

MatthewMiddlehurst · 2025-03-03T22:28:16Z

aeon/anomaly_detection/base.py

@@ -192,9 +192,10 @@ def fit_predict(self, X, y=None, axis=1) -> np.ndarray:
        Returns
        -------
        np.ndarray
-            A boolean, ``int`` or ``float`` array of length len(X), where each element
-            indicates whether the corresponding subsequence is anomalous or
+            A ``boolean``, ``int`` or ``float`` array of length ``len(X)``, where each


bool not boolean i think?

resolved the inconsistency of double quotes

ea51d19

AnaghDeshpande requested review from SebastianSchmidl and MatthewMiddlehurst as code owners February 19, 2025 17:35

aeon-actions-bot bot added anomaly detection Anomaly detection package documentation Improvements or additions to documentation labels Feb 19, 2025

AnaghDeshpande and others added 17 commits February 20, 2025 13:33

resolved the inconsistency of double ticks

935af19

resolved the pre-commit errors occuring due to flake8

e7d46a0

Update _cblof.py

8c6b92c

made changes in line number 19 and 145.

Automatic pre-commit fixes

139e2a7

Update _copod.py

dce8ca2

made changes in line number 76

Automatic pre-commit fixes

067dade

Update _iforest.py

603d0fa

made changes in line number 19

Automatic pre-commit fixes

0c3c30c

Update _kmeans.py

f6e163f

made changes in line number 178

Automatic pre-commit fixes

1d1e295

Update _merlin.py

3a9a738

made changes in line number 215

Automatic pre-commit fixes

53554ab

Update _one_class_svm.py

9ab38d8

made changes in line number 19

Automatic pre-commit fixes

0f7173c

Update _pyodadapter.py

63daa5f

made changes in line number 165

Update _stomp.py

3937b54

made changes in line number 125

Automatic pre-commit fixes

40d63ae

SebastianSchmidl reviewed Feb 21, 2025

View reviewed changes

SebastianSchmidl requested changes Feb 21, 2025

View reviewed changes

Merge branch 'main' into fix/inconsistent-double-quotes

5421e56

AnaghDeshpande added 3 commits February 25, 2025 17:22

converted directives to single ticks

c0c43bd

added double ticks to code ref

a6208c1

Merge branch 'fix/inconsistent-double-quotes' of https://github.com/A…

85e1147

…naghDeshpande/aeon into fix/inconsistent-double-quotes

SebastianSchmidl requested changes Feb 26, 2025

View reviewed changes

fixed link in cblof.py and some other minor changes

167c98a

AnaghDeshpande requested a review from SebastianSchmidl February 28, 2025 01:57

MatthewMiddlehurst reviewed Mar 3, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DOC] resolved the inconsistency of double ticks for the anomaly detection module #809 #2546

[DOC] resolved the inconsistency of double ticks for the anomaly detection module #809 #2546

AnaghDeshpande commented Feb 19, 2025

aeon-actions-bot bot commented Feb 19, 2025

SebastianSchmidl commented Feb 19, 2025

AnaghDeshpande commented Feb 20, 2025

SebastianSchmidl Feb 21, 2025 •

edited

Loading

AnaghDeshpande Feb 24, 2025

SebastianSchmidl Feb 21, 2025

SebastianSchmidl Feb 26, 2025

MatthewMiddlehurst commented Feb 25, 2025 •

edited

Loading

SebastianSchmidl Feb 26, 2025

SebastianSchmidl Feb 26, 2025

SebastianSchmidl Feb 26, 2025

MatthewMiddlehurst Mar 3, 2025

MatthewMiddlehurst Mar 3, 2025

MatthewMiddlehurst Mar 3, 2025

	- If ``auto``, then ``max_samples=min(256, n_samples)``.
	- If ``"auto"``, then ``max_samples=min(256, n_samples)``.

	If None, the random number generator is the RandomState instance used
	If ``None``, the random number generator is the RandomState instance used

[DOC] resolved the inconsistency of double ticks for the anomaly detection module #809 #2546

Are you sure you want to change the base?

[DOC] resolved the inconsistency of double ticks for the anomaly detection module #809 #2546

Conversation

AnaghDeshpande commented Feb 19, 2025

Reference Issues/PRs

What does this implement/fix? Explain your changes.

Does your contribution introduce a new dependency? If yes, which one?

Any other comments?

PR checklist

For all contributions

aeon-actions-bot bot commented Feb 19, 2025

Thank you for contributing to aeon

PR CI actions

SebastianSchmidl commented Feb 19, 2025

AnaghDeshpande commented Feb 20, 2025

SebastianSchmidl Feb 21, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

MatthewMiddlehurst commented Feb 25, 2025 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Thank you for contributing to `aeon`

SebastianSchmidl Feb 21, 2025 •

edited

Loading

MatthewMiddlehurst commented Feb 25, 2025 •

edited

Loading