Skip to content

[ENH] Adding tag for categorical support in X#6704

Merged
yarnabrina merged 4 commits intosktime:mainfrom
Abhay-Lejith:categorical_tag
Jul 19, 2024
Merged

[ENH] Adding tag for categorical support in X#6704
yarnabrina merged 4 commits intosktime:mainfrom
Abhay-Lejith:categorical_tag

Conversation

@Abhay-Lejith
Copy link
Copy Markdown
Contributor

@Abhay-Lejith Abhay-Lejith commented Jul 2, 2024

Reference Issues/PRs

Reference umbrella issue : #6109

What does this implement/fix? Explain your changes.

Added a tag to identify capability of estimator to natively support categorical in X.

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

No.

What should a reviewer concentrate their feedback on?

Did you add any tests for the change?

No.

Any other comments?

PR checklist

For all contributions
  • The PR title starts with either [ENH], [MNT], [DOC], or [BUG]. [BUG] - bugfix, [MNT] - CI, test framework, [ENH] - adding or improving code, [DOC] - writing or improving documentation or docstrings.

@Abhay-Lejith
Copy link
Copy Markdown
Contributor Author

Abhay-Lejith commented Jul 2, 2024 •
edited
Loading

Is the default for boolean tags fixed as False or does it have to be specified somewhere ?
Edit: I just realized the default is probably specified in the base class and overriden in specific forecasters if necessary. Correct me if I'm wrong.
And is there anything else to be done while adding a tag?

Also, please assign this issue and add it to the project board as well.

@Abhay-Lejith
Copy link
Copy Markdown
Contributor Author

Abhay-Lejith commented Jul 6, 2024

@fkiraly @yarnabrina Do I also have to add a class like this?

sktime/sktime/registry/_tags.py

Lines 601 to 639 in 7637d6f

class capability__exogeneous(_BaseTag):
"""Capability: the forecaster can use exogeneous data.
The tag is currently named ``ignores-exogeneous-X``, and will be renamed.
``False`` = does use exogeneous data, ``True`` = does not use exogeneous data.
- String name: ``"ignores-exogeneous-X"``
- Public capability tag
- Values: boolean, ``True`` / ``False``
- Example: ``True``
- Default: ``False``
- Alias: ``capability:exogeneous`` (currently not used)
Exogeneous data are additional time series,
that can be used to improve forecasting accuracy.
If the forecaster uses exogeneous data (``ignore-exogeneous-X=False``),
the ``X`` parmameter in ``fit``, ``predict``, and other methods
can be used to pass exogeneous data to the forecaster.
If the ``X-y-must-have-same-index`` tag is ``True``,
then such data must always have an index that contains that of the target series,
i.e., ``y`` in ``fit``, or the indices specified by ``fh`` in ``predict``.
If the tag is ``False``, the forecaster does not make use of exogeneous data.
``X`` parameters can still be passed to methods, to ensure a uniform interface,
but the data will be ignored,
i.e., not used in the internal logic of the forecaster.
"""
_tags = {
"tag_name": "ignores-exogeneous-X",
"parent_type": "forecaster",
"tag_type": "bool",
"short_descr": "does forecaster make use of exogeneous data?",
"user_facing": True,
}

yarnabrina
yarnabrina requested changes Jul 6, 2024
View reviewed changes
Copy link
Copy Markdown
Member

@yarnabrina yarnabrina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To your above question, yes, please add similar class to document tag details.

@Abhay-Lejith Abhay-Lejith mentioned this pull request Jul 7, 2024
Merged
1 task
@Abhay-Lejith Abhay-Lejith requested a review from yarnabrina July 9, 2024 08:08
@Abhay-Lejith
Copy link
Copy Markdown
Contributor Author

Abhay-Lejith commented Jul 9, 2024

Please assign this pr to me as well and let me know if there are any changes to be made.

yarnabrina
yarnabrina requested changes Jul 9, 2024
View reviewed changes
Copy link
Copy Markdown
Member

@yarnabrina yarnabrina left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The tag is missing here: https://sktime--6704.org.readthedocs.build/en/6704/api_reference/tags.html.

I think you need to add it to docs/source/conf.py as well.

sktime/docs/source/conf.py

Lines 349 to 361 in 6653854

"forecaster": [
"capability:insample",
"capability:pred_int",
"capability:pred_int:insample",
"handles-missing-data",
"ignores-exogeneous-X",
"scitype:y",
"requires-fh-in-fit",
"X-y-must-have-same-index",
"python_dependencies",
"authors",
"maintainers",
],

@Abhay-Lejith
Copy link
Copy Markdown
Contributor Author

Abhay-Lejith commented Jul 17, 2024 •
edited
Loading

The tag is missing here: https://sktime--6704.org.readthedocs.build/en/6704/api_reference/tags.html.

I think you need to add it to docs/source/conf.py as well.

It was because it wasn't present in tags.rst by the way. Not sure what adding the tag to conf.py does but I added it there as well.

@yarnabrina yarnabrina mentioned this pull request Jul 18, 2024
Open
@yarnabrina yarnabrina merged commit 19f58fa into sktime:main Jul 19, 2024
@yarnabrina yarnabrina mentioned this pull request Jul 19, 2024
Merged
yarnabrina added a commit to Abhay-Lejith/sktime that referenced this pull request Jul 20, 2024
@yarnabrina
Merge remote-tracking branch 'upstream/main' into pr/Abhay-Lejith/6732
23b4279 
* upstream/main:
  [ENH] Allow object dtype in series (sktime#5886)
  [ENH] `check_pdmultiindex_panel` to return names of invalid `object` columns if there are any (sktime#6797)
  [ENH] added feature_kind metadata in datatype checks (sktime#6490)
  [ENH] Adding tag for categorical support in `X` (sktime#6704)
  [BUG] Fix bug when predicting segments from clasp change point annotator (sktime#6756)
  [ENH] Adding support for GluonTS' PandasDataset object (sktime#6668)
Abhay-Lejith added a commit to Abhay-Lejith/sktime that referenced this pull request Jul 31, 2024
@Abhay-Lejith
Squashed commit of PR#6732 adding the following:
aa698b0 
commit 9f95d89
Merge: 02bd3fb 6caeb0d
Author: Abhay-Lejith <abhaylejith@gmail.com>
Date:   Tue Jul 30 22:01:03 2024 +0530

    Merge branch 'main' into step3-4_categorical_support

commit 02bd3fb
Merge: 53ee977 a21d97f
Author: Abhay-Lejith <abhaylejith@gmail.com>
Date:   Mon Jul 29 21:47:41 2024 +0530

    Merge branch 'main' into step3-4_categorical_support

commit 53ee977
Merge: 74fd3f8 9b066f2
Author: Franz Király <f.kiraly@ucl.ac.uk>
Date:   Sun Jul 28 15:19:13 2024 +0100

    Merge branch 'main' into pr/6732

commit 74fd3f8
Merge: e9f5e2b 116faa2
Author: Franz Király <f.kiraly@ucl.ac.uk>
Date:   Sun Jul 28 15:18:26 2024 +0100

    Merge branch 'main' into pr/6732

commit e9f5e2b
Author: Abhay-Lejith <Abhay-Lejith@users.noreply.github.com>
Date:   Sun Jul 28 10:32:15 2024 +0000

    [AUTOMATED] update CONTRIBUTORS.md

commit f3e212b
Merge: 95c213b 81d2d08
Author: Abhay-Lejith <abhaylejith@gmail.com>
Date:   Sun Jul 28 16:01:12 2024 +0530

    Merge branch 'main' into step3-4_categorical_support

commit 95c213b
Author: Abhay-Lejith <abhaylejith@gmail.com>
Date:   Sun Jul 28 15:59:02 2024 +0530

    added est.update to test_categorical

commit 8d14bde
Author: Abhay-Lejith <abhaylejith@gmail.com>
Date:   Sat Jul 27 09:35:51 2024 +0530

    typo, docs

commit 81b4862
Author: Abhay-Lejith <abhaylejith@gmail.com>
Date:   Thu Jul 25 22:27:00 2024 +0530

    separate test for categorical in y

commit 23b4279
Merge: a0d950d 3a55ca5
Author: Anirban Ray <39331844+yarnabrina@users.noreply.github.com>
Date:   Sat Jul 20 09:29:27 2024 +0530

    Merge remote-tracking branch 'upstream/main' into pr/Abhay-Lejith/6732

    * upstream/main:
      [ENH] Allow object dtype in series (sktime#5886)
      [ENH] `check_pdmultiindex_panel` to return names of invalid `object` columns if there are any (sktime#6797)
      [ENH] added feature_kind metadata in datatype checks (sktime#6490)
      [ENH] Adding tag for categorical support in `X` (sktime#6704)
      [BUG] Fix bug when predicting segments from clasp change point annotator (sktime#6756)
      [ENH] Adding support for GluonTS' PandasDataset object (sktime#6668)

commit a0d950d
Merge: 2d77fd6 1fa8cfc
Author: Abhay-Lejith <abhaylejith@gmail.com>
Date:   Wed Jul 17 22:03:27 2024 +0530

    Merge branch 'main' into step3-4_categorical_support

commit 2d77fd6
Author: Abhay-Lejith <abhaylejith@gmail.com>
Date:   Sat Jul 13 18:25:44 2024 +0530

    test error fix

commit 194ec28
Merge: 143a176 23bbb9b
Author: Abhay-Lejith <abhaylejith@gmail.com>
Date:   Sat Jul 13 17:16:00 2024 +0530

    Merge updated branch 'feature_kind' with timedelta dtype added

commit 143a176
Author: Abhay-Lejith <abhaylejith@gmail.com>
Date:   Sat Jul 13 17:11:59 2024 +0530

    added tests for categorical

commit 23bbb9b
Author: Abhay-Lejith <abhaylejith@gmail.com>
Date:   Fri Jul 12 12:31:52 2024 +0530

    added timedelta to DATETIME category

commit f926c58
Author: Abhay-Lejith <abhaylejith@gmail.com>
Date:   Fri Jul 12 10:40:29 2024 +0530

    added ignores-exog-X check to test for invalid X input

commit 460caba
Author: Abhay-Lejith <abhaylejith@gmail.com>
Date:   Fri Jul 12 09:32:09 2024 +0530

    added checks in transformers

commit 08aefa2
Author: Abhay-Lejith <abhaylejith@gmail.com>
Date:   Thu Jul 11 13:16:09 2024 +0530

    added categorical checks in other base classes

commit 0812220
Author: Abhay-Lejith <abhaylejith@gmail.com>
Date:   Tue Jul 9 13:29:22 2024 +0530

    linting blank line fix

commit 5f3be53
Author: Abhay-Lejith <abhaylejith@gmail.com>
Date:   Tue Jul 9 13:16:07 2024 +0530

    added feature_kind to req metadata in early classifiers

commit 1d7e443
Merge: 7377837 b1f6167
Author: Abhay-Lejith <abhaylejith@gmail.com>
Date:   Tue Jul 9 13:11:34 2024 +0530

    Merge branch updated 'feature_kind' with xarray and dask metadata support

commit b1f6167
Author: Abhay-Lejith <abhaylejith@gmail.com>
Date:   Tue Jul 9 13:00:36 2024 +0530

    added metadata for xarray and dask with tests

commit 0905bbb
Author: Abhay-Lejith <abhaylejith@gmail.com>
Date:   Mon Jul 8 13:23:36 2024 +0530

    dataloader test error workaround

commit 7377837
Merge: d36e05a 8652ba9
Author: Abhay-Lejith <abhaylejith@gmail.com>
Date:   Mon Jul 8 12:33:23 2024 +0530

    Merge branch updated 'feature_kind' with new bool mapping

commit 8652ba9
Author: Abhay-Lejith <abhaylejith@gmail.com>
Date:   Mon Jul 8 12:32:22 2024 +0530

    changed mapping of boolean dtypekind to float

commit d36e05a
Author: Abhay-Lejith <abhaylejith@gmail.com>
Date:   Sun Jul 7 16:56:21 2024 +0530

    moved handle_categorical call to after check_is_error

commit 403ee6e
Author: Abhay-Lejith <abhaylejith@gmail.com>
Date:   Sun Jul 7 16:52:39 2024 +0530

    indexing fix

commit a006004
Author: Abhay-Lejith <abhaylejith@gmail.com>
Date:   Sun Jul 7 16:52:39 2024 +0530

    indexing fix

commit 3696f7b
Author: Abhay-Lejith <Abhay-Lejith@users.noreply.github.com>
Date:   Sun Jul 7 10:17:26 2024 +0000

    [AUTOMATED] update CONTRIBUTORS.md

commit 05c452c
Author: Abhay-Lejith <abhaylejith@gmail.com>
Date:   Sun Jul 7 15:46:37 2024 +0530

    updated tag name

commit 4b557c6
Merge: 8cd48ed 978263e
Author: Abhay-Lejith <abhaylejith@gmail.com>
Date:   Sun Jul 7 15:43:14 2024 +0530

    Merge updated branch 'categorical_tag' with class for new tag

commit 978263e
Author: Abhay-Lejith <abhaylejith@gmail.com>
Date:   Sun Jul 7 15:41:19 2024 +0530

    added class for tag

commit 8cd48ed
Merge: 90c9f31 c1af183
Author: Abhay-Lejith <abhaylejith@gmail.com>
Date:   Sun Jul 7 13:19:34 2024 +0530

    Merge updated branch 'feature_kind' with table support

commit c1af183
Author: Abhay-Lejith <abhaylejith@gmail.com>
Date:   Sun Jul 7 13:07:56 2024 +0530

    extended to table scitype along with tests

commit 90c9f31
Author: Abhay-Lejith <abhaylejith@gmail.com>
Date:   Sun Jul 7 11:19:35 2024 +0530

    calling _handle_categorical in forecasting, classification, regression

commit 655f6e0
Author: Abhay-Lejith <abhaylejith@gmail.com>
Date:   Sun Jul 7 11:19:08 2024 +0530

    added categorical handling logic

commit db94559
Author: Abhay-Lejith <abhaylejith@gmail.com>
Date:   Thu Jul 4 10:29:48 2024 +0530

    added docstring and modified code acc to suggestion

commit 1321e1e
Merge: de6c92b 0eb9231
Author: Abhay-Lejith <abhaylejith@gmail.com>
Date:   Tue Jul 2 13:11:12 2024 +0530

    Merge pr sktime#5886 into step3-4_categorical_support

commit de6c92b
Merge: e376768 3f62d98
Author: Abhay-Lejith <abhaylejith@gmail.com>
Date:   Tue Jul 2 13:09:50 2024 +0530

    Merge branch 'feature_kind' into step3-4_categorical_support

commit e376768
Author: Abhay-Lejith <abhaylejith@gmail.com>
Date:   Tue Jul 2 11:06:07 2024 +0530

    added categorical tag

commit 3f62d98
Author: Abhay-Lejith <abhaylejith@gmail.com>
Date:   Mon Jul 1 11:08:47 2024 +0530

    added separate tests for testing with categorical data

commit e806cc1
Author: Abhay-Lejith <abhaylejith@gmail.com>
Date:   Mon Jun 24 11:09:08 2024 +0530

    renamed fields and rmeoved use of pandas func for numpy based mtypes

commit 7a58087
Author: Abhay-Lejith <abhaylejith@gmail.com>
Date:   Wed Jun 12 18:33:18 2024 +0530

    added simple_feature_kind and reverted changes to examples

commit ee0bc1c
Author: Abhay-Lejith <abhaylejith@gmail.com>
Date:   Mon Jun 3 12:02:30 2024 +0530

    changed dtype to float in panel examples which I missed earlier

commit 2f84b24
Merge: 1a64d2f e22d8dc
Author: Abhay-Lejith <abhaylejith@gmail.com>
Date:   Mon Jun 3 10:11:30 2024 +0530

    Merge branch 'main' into feature_kind

commit 1a64d2f
Author: Abhay-Lejith <abhaylejith@gmail.com>
Date:   Mon Jun 3 10:07:19 2024 +0530

    changed dtype to float in panel test examples

commit dd81851
Author: Abhay-Lejith <abhaylejith@gmail.com>
Date:   Sat Jun 1 16:20:17 2024 +0530

    added dtypekind metadata for panel and hierarchical

commit 83b6fe8
Author: Abhay-Lejith <abhaylejith@gmail.com>
Date:   Fri May 31 10:25:28 2024 +0530

    using pandas api functions to detect dtype

commit c0962f9
Author: Abhay-Lejith <abhaylejith@gmail.com>
Date:   Thu May 30 12:17:51 2024 +0530

    added function for getting dtypekind of series

commit 1e2110a
Merge: 898b839 6f42855
Author: Franz Király <f.kiraly@ucl.ac.uk>
Date:   Wed May 29 13:54:43 2024 +0100

    Merge branch 'main' into pr/6490

commit 898b839
Author: Abhay-Lejith <abhaylejith@gmail.com>
Date:   Wed May 29 11:04:28 2024 +0530

    using dtypekind enum values

commit ee8e0c4
Author: Abhay-Lejith <abhaylejith@gmail.com>
Date:   Tue May 28 14:50:43 2024 +0530

    added feature_kind metadata in series check

commit 0eb9231
Author: Anirban Ray <39331844+yarnabrina@users.noreply.github.com>
Date:   Fri Feb 16 23:37:36 2024 +0530

    @fkiraly suggestion: add rule to differentiate nested_univ and Panel

commit 0e28842
Author: Anirban Ray <39331844+yarnabrina@users.noreply.github.com>
Date:   Fri Feb 16 10:46:16 2024 +0530

    support "object" dtype in Panel

    (cherry picked from commit 1477012)

commit 25eb6f5
Author: Anirban Ray <39331844+yarnabrina@users.noreply.github.com>
Date:   Fri Feb 16 10:42:17 2024 +0530

    @fkiraly edit: add rule to differentiate nested_univ and pd.DataFrame

    Ref. sktime#5886 (review)

    (cherry picked from commit 2cecd6b)

commit a729843
Author: Anirban Ray <39331844+yarnabrina@users.noreply.github.com>
Date:   Sat Feb 3 18:29:15 2024 +0530

    added test

    (cherry picked from commit 2de7d8c)

commit c624e42
Author: Anirban Ray <39331844+yarnabrina@users.noreply.github.com>
Date:   Sat Feb 3 18:28:47 2024 +0530

    support "object" dtype in Series

    (cherry picked from commit cc3d056)
fkiraly pushed a commit that referenced this pull request Aug 6, 2024
@Abhay-Lejith
[ENH] Adding categorical support: Raising error in yes/no case (#6732)
ef6f105 
#### Reference Issues/PRs

Reference umbrella issue comment
:#6109 (comment)
This is step 4 mentioned in that comment.

This PR **depends** on:
#6704 : Adding new categorical tag
#6490 : Feature_kind metadata

i.e this PR requires and contains commits of the above two PRs.

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

Implementation of logic for handling categorical data and raising error
appropriately.
Raising error in yes/no case is only in forecasters. 
yes/no case - data has categorical , forecaster does not support.
In other modules(except classification), error is raised directly if
categorical is present.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@yarnabrina yarnabrina yarnabrina approved these changes

@achieveordie achieveordie Awaiting requested review from achieveordie

@benHeid benHeid Awaiting requested review from benHeid benHeid is a code owner

@fkiraly fkiraly Awaiting requested review from fkiraly fkiraly is a code owner

Assignees

@Abhay-Lejith Abhay-Lejith

Labels

None yet

Projects

2024 May-Sep workstreams
Status: Done

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Abhay-Lejith @yarnabrina