Docs/examples migrate to 2p5#448
Open
kr3shna wants to merge 2 commits into
Open
Conversation
Add root CONTRIBUTING.md and development_setup.md, fix AGENTS.md to point at the current test suite, declare dev optional dependencies, and run tests in CI alongside the existing package build.
Replace removed v1 API usage with from_pretrained + ForecastConfig, fix 2.5 quantile column mapping in animation output, and refresh committed example artifacts. Closes google-research#423
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Migrate remaining TimesFM 2.5 forecasting examples from the removed v1 API (
TimesFmHparams/TimesFmCheckpoint/TimesFm) to the current API (from_pretrained+ForecastConfig+forecast()).detect_anomalies.py— load TimesFM 2.5 and forecast with quantile prediction intervalsgenerate_animation_data.py— same API migration; fix quantile column mapping for 2.5 ([mean, q10, …, q90]—q10at index 1, not 0)global-temperature/README.md— document the working 2.5 API; remove outdated v1 / safetensors guidancegenerate_html.py— footer updated to TimesFM 2.5animation_data.json,interactive_forecast.html, anomaly detection outputs)Builds on the prior global-temperature
run_forecast.pymigration to the 2.5 API.Related
Test plan
py_compileon migrated scriptspytest tests/ --ignore=tests/test_model_loading.py(58 passed)detect_anomalies.py— exits 0; 1 context CRITICAL (2023-09), forecast PI anomalies detectedgenerate_animation_data.py— 25/25 steps; final step mean 1.235°Cgenerate_html.py— self-contained HTML generatedrun_forecast.pyoutputq10 ≤ q20 ≤ q80 ≤ q90); HTML footer shows TimesFM 2.5