Skip to content

[DOC] Fix inconsistent double back ticks for the transformations module #809 #2709

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

[DOC] Fix inconsistent double back ticks for the transformations module #809 #2709

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6e3b536
fixed double ticks in the transformations module
Omabekee Mar 31, 2025
1b163f9
Merge branch 'main' into fix-docs-new
MatthewMiddlehurst Apr 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions examples/transformations/catch22.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -276,7 +276,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"You may find that some time series cannot extract certain features from it. This may happen when division by zero occurs, or the input value is zero. Simply, it means we cannot extract the feature from the time series. However, we may still want a number for calculations and therefore 'replace_nans' allows us to replace NaN with zero."
"You may find that some time series cannot extract certain features from it. This may happen when division by zero occurs, or the input value is zero. Simply, it means we cannot extract the feature from the time series. However, we may still want a number for calculations and therefore ``'replace_nans'`` allows us to replace ``NaN`` with zero."
]
},
{
Expand Down Expand Up @@ -323,7 +323,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"Pycatch22 is the original implementation of catch22 based on \\[1\\]. Aeon allows you to use pycatch22 by setting the parameter 'use_pycatch22' to true. The difference of the two is that pycatch22 uses C as their backend while python uses the Numba library, which assembles python code into C. Aeon also regularly maintains their catch22 library, and therefore there should be barely any discrepancy between outputs. Pycatch22 has a few issues with their implementation such as at times struggling to run on windows. If you are using the aeon library for a certain task, but want to use pycatch22 for transformation of the data, it is recommended to use aeon's catch22 with the parameter 'use_pycatch22' set to true. If you do that, you may encounter a warning that pycatch22 has not been installed and therefore will use aeon's catch22, if that happens just install the pycatch22 library.\n",
"Pycatch22 is the original implementation of catch22 based on \\[1\\]. Aeon allows you to use pycatch22 by setting the parameter ``'use_pycatch22'`` to true. The difference of the two is that pycatch22 uses C as their backend while python uses the Numba library, which assembles python code into C. Aeon also regularly maintains their catch22 library, and therefore there should be barely any discrepancy between outputs. Pycatch22 has a few issues with their implementation such as at times struggling to run on windows. If you are using the aeon library for a certain task, but want to use pycatch22 for transformation of the data, it is recommended to use aeon's catch22 with the parameter ``'use_pycatch22'`` set to true. If you do that, you may encounter a warning that pycatch22 has not been installed and therefore will use aeon's catch22, if that happens just install the pycatch22 library.\n",
"\n",
"Currently, pycatch22 has an issue where the output features extracted using Python yield different values compared to those extracted using the native C code. Aeon's catch22 implementation extracts the same results as pycatch22's C code. Therefore, the extracted results may differ."
]
Expand Down
Loading