Skip to content
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.

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

add option for short names #18

Merged
merged 2 commits into from
Oct 16, 2023

Conversation

anniegbryant
Copy link
Member

No description provided.

@benfulcher
Copy link
Contributor

I wonder if you can put the features_short in the same object as features…? This will help see them side-by-side for clarity/cleanliness…E.g., a 22 x 2 object…? Or a dictionary with long and short fields? I'm not sure what the best python version is for this… But if it's a hassle, let me know—this works too!

@anniegbryant
Copy link
Member Author

Currently, catch22.py returns a dictionary with two keys: names containing the list of features and values containing the list of feature values. The suggested change would also add a third key to the dictionary, short_names, containing the list of shorthand feature names -- if the user sets short_names=True. I thought it best to keep the output format as consistent as possible with (A) what users have been accustomed to thus far and (B) to keep output formats directly comparable whether a user includes the short_names=True flag.

I think the cleanest way to implement this would be to return the results as a pandas DataFrame object with either two or three columns, though this would require including numpy and pandas as installation requirements for the package as well. What do you think?

@benfulcher
Copy link
Contributor

I'm not the most knowledgeable in python, but I would expect python users doing time-series analysis to have numpy and pandas… There is always a risk with adding and tracking dependencies, but the functionality here is so basic that I don't think it's an issue…? I'll merge the current version for now.

@benfulcher benfulcher merged commit 463d651 into DynamicsAndNeuralSystems:main Oct 16, 2023
fkiraly pushed a commit to sktime/sktime that referenced this pull request Mar 5, 2024
…umn names, short aliases, refactor to `pd.Series`, `sktime` native parallelization (#6002)

#### What does this implement/fix? Explain your changes.

Simplifies the `Catch22` code to be in accordance with the current version of
sktime, similarly to #5981.
Adds option to add column names in the output, with short names option
similarly to
DynamicsAndNeuralSystems/pycatch22#18

* Changed logic from looping over nested_univ series to a single
pd.Series approach.
* Private catch22 from `_catch22_numba.py` functions are now passed
through a dict
* `_catch22_numba.py` now accesses variables passed through a dict,
not indirectly, to simplify the logic of passing arguments in the main
`catch22.py` module
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants