Skip to content

Comments

Update timing defaults in forecasting schema#1974

Draft
BelhsanHmida wants to merge 151 commits intofeat/optional-training-startfrom
dev/new-forecasting-defaults
Draft

Update timing defaults in forecasting schema#1974
BelhsanHmida wants to merge 151 commits intofeat/optional-training-startfrom
dev/new-forecasting-defaults

Conversation

@BelhsanHmida
Copy link
Contributor

@BelhsanHmida BelhsanHmida commented Feb 17, 2026 •
edited by Flix6x
Loading

Description

This PR updates values for forecasting timing parameters so that the expected test cases pass.

Timing defaults

  • predict-period → min(FM planning horizon, max-forecast-horizon)
  • max-forecast-horizon → predict-period
  • forecast-frequency → min(FM planning horizon, predict-period, max-forecast-horizon, retraining-frequency)
  • retraining-frequency → FM planning horizon

Constraint

  • max-forecast-horizon <= predict-period

Changes

  • Add timing defaults to forecasting schema
  • tests expects validation error
  • Ensure all forecasting tests pass

Sign-off

  • I agree to contribute to the project under Apache 2 License.
  • To the best of my knowledge, the proposed patch is not based on code under GPL or other license that is incompatible with FlexMeasures

@BelhsanHmida
feat: make predict retrain-frequency default to planning horizon then…
7d85db0 
… min(planning_horizon, data["max_forecast_horizon"])

Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>
@BelhsanHmida
refactor: simplify end_date calculation to use predict_period instead…
39e64ec 
… of timedelta

Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>
@BelhsanHmida
feat: default max_forecast_horizon to predict_period
9d83911 
Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>
@BelhsanHmida
feat: add validation for max_forecast_horizon to ensure it does not e…
7543395 
…xceed predict_period

Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>
@BelhsanHmida
feat: set default forecast_frequency based on min of planning_horizon…
da4b943 
…, predict_period, and max_forecast_horizon

Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>
@BelhsanHmida
fix: add planning horizon from config
43d8d9d 
Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>
@BelhsanHmida
dev: uncomment out tests that were failing
b3dd12d 
Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>
@BelhsanHmida
fix: fix test cae forecast_frequency expectation it should be 12 hour…
24f1569 
…s not 48hours since we want New forecast viewpoint every 12 hours

Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>
@BelhsanHmida
fix: tests should expect 5 cycles. the test passes when we expect 1cycle
9c5d677 
Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>
@read-the-docs-community
Copy link

read-the-docs-community bot commented Feb 17, 2026 •
edited
Loading

Documentation build overview

📚 flexmeasures | 🛠️ Build #31518156 | 📁 Comparing 39d250e against latest (d2d93ce)


🔍 Preview build

Show files changed (20 files in total): 📝 19 modified | ➕ 0 added | ➖ 1 deleted
File Status
changelog.html 📝 modified
genindex.html 📝 modified
index.html 📝 modified
_autosummary/flexmeasures.api.common.responses.html 📝 modified
_autosummary/flexmeasures.api.v3_0.sensors.html 📝 modified
_autosummary/flexmeasures.cli.utils.html 📝 modified
_autosummary/flexmeasures.data.models.data_sources.html 📝 modified
_autosummary/flexmeasures.data.models.forecasting.exceptions.html 📝 modified
_autosummary/flexmeasures.data.models.forecasting.html 📝 modified
_autosummary/flexmeasures.data.models.forecasting.pipelines.base.html 📝 modified
_autosummary/flexmeasures.data.models.forecasting.pipelines.train_predict.html 📝 modified
_autosummary/flexmeasures.data.schemas.forecasting.pipeline.html 📝 modified
_autosummary/flexmeasures.data.schemas.utils.html 📝 modified
_autosummary/flexmeasures.data.services.data_sources.html 📝 modified
api/v3_0.html 📝 modified
cli/change_log.html 📝 modified
concepts/commitments.html ➖ deleted
concepts/device_scheduler.html 📝 modified
features/forecasting.html 📝 modified
tut/forecasting_scheduling.html 📝 modified

Flix6x and others added 20 commits February 17, 2026 10:52
@Flix6x
feat: add duration to schema
3642c9a 
Signed-off-by: F.N. Claessen <claessen@seita.nl>
@Flix6x
feat: pass original data to resolve_config so we can check whether …
a448bf5 
…start, end and duration have been passed

Signed-off-by: F.N. Claessen <claessen@seita.nl>
@BelhsanHmida
feat: move end_date calculation up
3456ffd 
Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>
@BelhsanHmida
feat: fix max-forecast-horizon and forecast freq default calculation
a3c63a4 
Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>
@Flix6x
Merge remote-tracking branch 'origin/dev/new-forecasting-defaults' in…
acacac8 
…to dev/new-forecasting-defaults
@BelhsanHmida
dev: remove breakpoint
2c6e846 
Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>
@Flix6x
feat: throw ValidationError in case start, end and duration are all p…
b4d261c 
…assed

Signed-off-by: F.N. Claessen <claessen@seita.nl>
@Flix6x
Merge remote-tracking branch 'origin/dev/new-forecasting-defaults' in…
cffe37e 
…to dev/new-forecasting-defaults
@BelhsanHmida
fix: remove unneeded validation
32e06af 
Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>
@BelhsanHmida
style: run pre-commit
f3c31ab 
Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>
@Flix6x
refactor: move check to pre_load
2a805f0 
Signed-off-by: F.N. Claessen <claessen@seita.nl>
@Flix6x
Merge remote-tracking branch 'origin/dev/new-forecasting-defaults' in…
dda8485 
…to dev/new-forecasting-defaults
@BelhsanHmida
dev: comment out tests cases that pass
9e7acc9 
Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>
@BelhsanHmida
fix: fix calculation for retrain_freq
6a5591c 
Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>
@BelhsanHmida
Revert "dev: comment out tests cases that pass"
e4833df 
This reverts commit 9e7acc9.
@BelhsanHmida
style: run pre-commit
6db140d 
Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>
@BelhsanHmida
chore: regenerate openapi-spec.json
a2819ed 
Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>
@Flix6x
refactor: move parametrized cases next to case descriptions
930cf1c 
Signed-off-by: F.N. Claessen <claessen@seita.nl>
@Flix6x
dev: remove breakpoint
e8fab7e 
Signed-off-by: F.N. Claessen <claessen@seita.nl>
@Flix6x
fix: check predict period
875ad1a 
Signed-off-by: F.N. Claessen <claessen@seita.nl>
Flix6x and others added 30 commits February 21, 2026 10:15
@Flix6x
refactor: simplify logic for deriving the training period
c3291ae 
Signed-off-by: F.N. Claessen <claessen@seita.nl>
@Flix6x
style: flake8
de2256e 
Signed-off-by: F.N. Claessen <claessen@seita.nl>
@Flix6x
chore: update openapi-specs.json
ca193dd 
Signed-off-by: F.N. Claessen <claessen@seita.nl>
@Flix6x
fix: remove CLI-only fields from nested config, too
6ba606a 
Signed-off-by: F.N. Claessen <claessen@seita.nl>
@Flix6x
feat: remove end-date and training timing fields from API docs
6b08dfe 
Signed-off-by: F.N. Claessen <claessen@seita.nl>
@BelhsanHmida
refactor: rename start-predict-date to start
e1dd3fb 
Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>
@BelhsanHmida
refactor: change start-date to train-start
0f31621 
Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>
@BelhsanHmida
refactor: change end-date to end
a355761 
Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>
@BelhsanHmida
refactor: update forecasting job JSON keys to match new naming conven…
4f8eb27 
…tions

Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>
@BelhsanHmida
refactor: update forecasting trigger schema keys to match new naming …
7630e12 
…conventions

Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>
@BelhsanHmida
refactor: update job metadata keys to match new naming conventions
fdcd8ca 
Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>
@BelhsanHmida
refactor: update forecasting job metadata keys to match new naming co…
2ddec9a 
…nventions

Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>
@BelhsanHmida
refactor: update forecasting parameter keys to match new naming conve…
8287355 
…ntions

Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>
@BelhsanHmida
refactor(test): update forecast job payload and job metadata keys to …
4976e37 
…match new naming conventions

Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>
@BelhsanHmida
doc: fix comment typo
bfedd0d 
Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>
@BelhsanHmida
refactor(tests): update test cases to use 'end' and 'train-start' keys
b38f6eb 
Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>
@BelhsanHmida
chore: update field names in comments
57dd7de 
Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>
@BelhsanHmida
refactor(tests): update date keys in test cases to match new naming c…
073e9a8 
…onventions

Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>
@Flix6x
style: black
e374f63 
Signed-off-by: F.N. Claessen <claessen@seita.nl>
@BelhsanHmida
refactor(doc): update forecasting job example to use 'duration' inste…
36b9a15 
…ad of 'end' key

Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>
@BelhsanHmida
refactor(api): update forecasting trigger example to use 'duration' i…
4d58440 
…nstead of 'end' key

Signed-off-by: Mohamed Belhsan Hmida <mohamedbelhsanhmida@gmail.com>
@Flix6x
feat: remove max-forecast-horizon field from API docs
9f16d56 
Signed-off-by: F.N. Claessen <claessen@seita.nl>
@Flix6x
docs: fix typo
1054e3d 
Signed-off-by: F.N. Claessen <claessen@seita.nl>
@Flix6x
chore: update openapi-specs.json
ebe85fa 
Signed-off-by: F.N. Claessen <claessen@seita.nl>
@Flix6x
docs: clarify mention of planning horizon in forecast duration field
93c25e0 
Signed-off-by: F.N. Claessen <claessen@seita.nl>
@Flix6x
docs: clarify use case for forecast-frequency field
6570332 
Signed-off-by: F.N. Claessen <claessen@seita.nl>
@Flix6x
feat: expose duration field to the CLI
28a4883 
Signed-off-by: F.N. Claessen <claessen@seita.nl>
@Flix6x
docs: capitalize start of sentence
fd0736f 
Signed-off-by: F.N. Claessen <claessen@seita.nl>
@Flix6x
fix: (CLI) description of end field
a81acb7 
Signed-off-by: F.N. Claessen <claessen@seita.nl>
@Flix6x
style: flake8
39d250e 
Signed-off-by: F.N. Claessen <claessen@seita.nl>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@BelhsanHmida @Flix6x