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.

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

Jump to bottom

[DOC] fixing docstring example for FhPlexForecaster #4931

Merged
merged 6 commits into from
Oct 14, 2023
Merged

[DOC] fixing docstring example for FhPlexForecaster #4931

merged 6 commits into from
Oct 14, 2023

Conversation

fkiraly
Copy link
Collaborator

@fkiraly fkiraly commented Jul 22, 2023 •
edited
Loading

Reference Issues/PRs

Fixes #4930

What does this implement/fix? Explain your changes.

adds an example for FhPlexForecaster, removes the wrong example

What should a reviewer concentrate their feedback on?

Are these sensible examples?

This is still work in progess, I´m just getting started (therefore draft); is this going in the right direction?

Did you add any tests for the change?

not needed - covered by dictest

Any other comments?

"showcase" for the community sprint, therefore not complete

@fkiraly fkiraly added documentation Documentation & tutorials module:forecasting forecasting module: forecasting, incl probabilistic and hierarchical forecasting labels Jul 22, 2023
@fkiraly fkiraly changed the title [DOC] fixing example for FhPlexForecaster [DOC] fixing docstring example for FhPlexForecaster Jul 22, 2023
@fkiraly fkiraly marked this pull request as ready for review October 12, 2023 18:55
@fkiraly fkiraly merged commit d69caf7 into main Oct 14, 2023
24 checks passed
@fkiraly fkiraly deleted the 4930-fix-fhplex-docexample branch October 14, 2023 09:49
yarnabrina added a commit to yarnabrina/sktime-fork that referenced this pull request Oct 14, 2023
@yarnabrina
Merge remote-tracking branch 'origin/main' into split-ci
1d6725b 
* origin/main: (24 commits)
  [DOC] fixing docstring example for `FhPlexForecaster` (sktime#4931)
  Revert "[MNT] instant release action" (sktime#5421)
  [MNT] instant release action (sktime#5419)
  Release 0.24.0 (sktime#5403)
  🚀 python 3.12 🚀  (sktime#5345)
  Revert "[MNT] instant release action" (sktime#5415)
  [MNT] 0.24.0 deprecations and change actions (sktime#5404)
  [MNT] [Dependabot](deps-dev): Update holidays requirement from <0.34,>=0.29 to >=0.29,<0.35 (sktime#5342)
  [MNT] Migrate from `pykalman` to `pykalman-bardo` (sktime#5277)
  [MNT] [Dependabot](deps-dev): Update skpro requirement from <2.1.0,>=2.0.0 to >=2.0.0,<2.2.0 (sktime#5396)
  [MNT] [Dependabot](deps-dev): Update numba requirement from <0.58,>=0.53 to >=0.53,<0.59 (sktime#5319)
  [MNT] update numba requirement from <0.58,>=0.53 to >=0.53,<0.59"" (sktime#5299)
  [MNT] instant release action (sktime#5265)
  Release 0.23.1 - omitted changelog commit (sktime#5413)
  Release 0.23.1 (sktime#5402)
  [ENH] Refactor of `DateTimeFeatures` tests to `pytest` fixtures (sktime#5397)
  [ENH] remove legacy except in `TestAllEstimators` for `predict_proba` (sktime#5386)
  [DOC] update docstring of `temporal_train_test_split` (sktime#4170)
  [ENH] parallelization backend calls in utility module - part 3, backend parameter passing in base class broadcasting (sktime#5405)
  [MNT] warnings config (sktime#4536)
  ...
yarnabrina added a commit to yarnabrina/sktime-fork that referenced this pull request Oct 14, 2023
@yarnabrina
Merge remote-tracking branch 'origin/main' into split-ci
00c83eb 
* origin/main: (24 commits)
  [DOC] fixing docstring example for `FhPlexForecaster` (sktime#4931)
  Revert "[MNT] instant release action" (sktime#5421)
  [MNT] instant release action (sktime#5419)
  Release 0.24.0 (sktime#5403)
  🚀 python 3.12 🚀  (sktime#5345)
  Revert "[MNT] instant release action" (sktime#5415)
  [MNT] 0.24.0 deprecations and change actions (sktime#5404)
  [MNT] [Dependabot](deps-dev): Update holidays requirement from <0.34,>=0.29 to >=0.29,<0.35 (sktime#5342)
  [MNT] Migrate from `pykalman` to `pykalman-bardo` (sktime#5277)
  [MNT] [Dependabot](deps-dev): Update skpro requirement from <2.1.0,>=2.0.0 to >=2.0.0,<2.2.0 (sktime#5396)
  [MNT] [Dependabot](deps-dev): Update numba requirement from <0.58,>=0.53 to >=0.53,<0.59 (sktime#5319)
  [MNT] update numba requirement from <0.58,>=0.53 to >=0.53,<0.59"" (sktime#5299)
  [MNT] instant release action (sktime#5265)
  Release 0.23.1 - omitted changelog commit (sktime#5413)
  Release 0.23.1 (sktime#5402)
  [ENH] Refactor of `DateTimeFeatures` tests to `pytest` fixtures (sktime#5397)
  [ENH] remove legacy except in `TestAllEstimators` for `predict_proba` (sktime#5386)
  [DOC] update docstring of `temporal_train_test_split` (sktime#4170)
  [ENH] parallelization backend calls in utility module - part 3, backend parameter passing in base class broadcasting (sktime#5405)
  [MNT] warnings config (sktime#4536)
  ...
yarnabrina added a commit to yarnabrina/sktime-fork that referenced this pull request Oct 14, 2023
@yarnabrina
Merge remote-tracking branch 'origin/split-ci' into test-change-in-fo…
76a8869 
…recasting

* origin/split-ci: (25 commits)
  Revert "removed test-full workflow"
  [DOC] fixing docstring example for `FhPlexForecaster` (sktime#4931)
  Revert "[MNT] instant release action" (sktime#5421)
  [MNT] instant release action (sktime#5419)
  Release 0.24.0 (sktime#5403)
  🚀 python 3.12 🚀  (sktime#5345)
  Revert "[MNT] instant release action" (sktime#5415)
  [MNT] 0.24.0 deprecations and change actions (sktime#5404)
  [MNT] [Dependabot](deps-dev): Update holidays requirement from <0.34,>=0.29 to >=0.29,<0.35 (sktime#5342)
  [MNT] Migrate from `pykalman` to `pykalman-bardo` (sktime#5277)
  [MNT] [Dependabot](deps-dev): Update skpro requirement from <2.1.0,>=2.0.0 to >=2.0.0,<2.2.0 (sktime#5396)
  [MNT] [Dependabot](deps-dev): Update numba requirement from <0.58,>=0.53 to >=0.53,<0.59 (sktime#5319)
  [MNT] update numba requirement from <0.58,>=0.53 to >=0.53,<0.59"" (sktime#5299)
  [MNT] instant release action (sktime#5265)
  Release 0.23.1 - omitted changelog commit (sktime#5413)
  Release 0.23.1 (sktime#5402)
  [ENH] Refactor of `DateTimeFeatures` tests to `pytest` fixtures (sktime#5397)
  [ENH] remove legacy except in `TestAllEstimators` for `predict_proba` (sktime#5386)
  [DOC] update docstring of `temporal_train_test_split` (sktime#4170)
  [ENH] parallelization backend calls in utility module - part 3, backend parameter passing in base class broadcasting (sktime#5405)
  ...
yarnabrina added a commit to yarnabrina/sktime-fork that referenced this pull request Oct 14, 2023
@yarnabrina
Merge remote-tracking branch 'origin/split-ci' into test-change-in-base
103c30d 
* origin/split-ci: (25 commits)
  Revert "removed test-full workflow"
  [DOC] fixing docstring example for `FhPlexForecaster` (sktime#4931)
  Revert "[MNT] instant release action" (sktime#5421)
  [MNT] instant release action (sktime#5419)
  Release 0.24.0 (sktime#5403)
  🚀 python 3.12 🚀  (sktime#5345)
  Revert "[MNT] instant release action" (sktime#5415)
  [MNT] 0.24.0 deprecations and change actions (sktime#5404)
  [MNT] [Dependabot](deps-dev): Update holidays requirement from <0.34,>=0.29 to >=0.29,<0.35 (sktime#5342)
  [MNT] Migrate from `pykalman` to `pykalman-bardo` (sktime#5277)
  [MNT] [Dependabot](deps-dev): Update skpro requirement from <2.1.0,>=2.0.0 to >=2.0.0,<2.2.0 (sktime#5396)
  [MNT] [Dependabot](deps-dev): Update numba requirement from <0.58,>=0.53 to >=0.53,<0.59 (sktime#5319)
  [MNT] update numba requirement from <0.58,>=0.53 to >=0.53,<0.59"" (sktime#5299)
  [MNT] instant release action (sktime#5265)
  Release 0.23.1 - omitted changelog commit (sktime#5413)
  Release 0.23.1 (sktime#5402)
  [ENH] Refactor of `DateTimeFeatures` tests to `pytest` fixtures (sktime#5397)
  [ENH] remove legacy except in `TestAllEstimators` for `predict_proba` (sktime#5386)
  [DOC] update docstring of `temporal_train_test_split` (sktime#4170)
  [ENH] parallelization backend calls in utility module - part 3, backend parameter passing in base class broadcasting (sktime#5405)
  ...
yarnabrina added a commit to yarnabrina/sktime-fork that referenced this pull request Oct 14, 2023
@yarnabrina
Merge remote-tracking branch 'origin/auto-format-pyproject' into vali…
f353053 
…date-extras-workflow

* origin/auto-format-pyproject: (27 commits)
  added new hook
  format using new hook
  added new hook
  [DOC] fixing docstring example for `FhPlexForecaster` (sktime#4931)
  Revert "[MNT] instant release action" (sktime#5421)
  [MNT] instant release action (sktime#5419)
  Release 0.24.0 (sktime#5403)
  🚀 python 3.12 🚀  (sktime#5345)
  Revert "[MNT] instant release action" (sktime#5415)
  [MNT] 0.24.0 deprecations and change actions (sktime#5404)
  [MNT] [Dependabot](deps-dev): Update holidays requirement from <0.34,>=0.29 to >=0.29,<0.35 (sktime#5342)
  [MNT] Migrate from `pykalman` to `pykalman-bardo` (sktime#5277)
  [MNT] [Dependabot](deps-dev): Update skpro requirement from <2.1.0,>=2.0.0 to >=2.0.0,<2.2.0 (sktime#5396)
  [MNT] [Dependabot](deps-dev): Update numba requirement from <0.58,>=0.53 to >=0.53,<0.59 (sktime#5319)
  [MNT] update numba requirement from <0.58,>=0.53 to >=0.53,<0.59"" (sktime#5299)
  [MNT] instant release action (sktime#5265)
  Release 0.23.1 - omitted changelog commit (sktime#5413)
  Release 0.23.1 (sktime#5402)
  [ENH] Refactor of `DateTimeFeatures` tests to `pytest` fixtures (sktime#5397)
  [ENH] remove legacy except in `TestAllEstimators` for `predict_proba` (sktime#5386)
  ...
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

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

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

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

Assignees
No one assigned
Labels
documentation Documentation & tutorials module:forecasting forecasting module: forecasting, incl probabilistic and hierarchical forecasting
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[DOC] docstring example in FhPlexForecaster is for the wrong forecaster
1 participant
@fkiraly