Skip to content

Add Chronos2 documentation - #1320

Merged
rusty1s merged 1 commit into
mainfrom
chronos2-doc
Oct 31, 2026
Merged

rusty1s merged 1 commit into
mainfrom
chronos2-doc

Conversation

@rusty1s

@rusty1s rusty1s commented Oct 31, 2026

Copy link
Copy Markdown
Collaborator

No description provided.

@coderabbitai

coderabbitai Bot commented Oct 31, 2026

Copy link
Copy Markdown
Contributor

Review in Change Stack →

No actionable comments were generated in the recent review.

Recent review info
Run configuration
Commits

Reviewing files that changed from the base of the PR and between 084aa7c and 59c1216.

Files ignored due to path filters: 2
  • docs/source/images/chronos2_dark.svg is excluded by !**/*.svg
  • docs/source/images/chronos2_light.svg is excluded by !**/*.svg
Files selected for processing: 2
  • sdm/models/chronos2/model.py
  • sdm/models/timesfm3/model.py

Included review availability: This review used your included allowance. Your plan provides up to 12 included reviews per hour; 11 remain after this review.

Summary

Summary by CodeRabbit

  • Documentation
    • Clarified Chronos2’s forecasting capabilities, supported inputs and outputs, limits, and batch behavior.
    • Updated TimesFM3’s description to reflect multivariate forecasting and joint forecasting of coevolving series.

The Chronos2 class description now covers its forecasting capabilities and limits. The TimesFM3 class description identifies it as a foundation model for multivariate forecasting and removes the “zero-shot” wording.

Changes: Model descriptions

Layer / File(s) Summary
Model documentation
sdm/models/chronos2/model.py, sdm/models/timesfm3/model.py
The Chronos2 description adds details about architecture, quantile outputs, input roles, forecast and context limits, and batch behavior. The TimesFM3 description removes “zero-shot” and describes multivariate forecasting.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Merge Risk: Minimal · up to 59c12

These documentation-only changes are mergeable with no identified implementation risk.

Pre-merge checks: Passed 4 · Inconclusive 1

Failed Failed checks: 1 inconclusive

Check name Status Explanation Resolution
Description check Inconclusive No pull request description was provided. The available objectives identify the Chronos2 documentation change, but the author did not provide a description that relates the changeset to the pull req… Add a brief description that summarizes the Chronos2 documentation updates and mentions the related TimesFM3 documentation change.
Passed Passed checks: 4 passed
Check name Status Explanation
Title check Passed The title accurately identifies the primary change: adding Chronos2 documentation. It does not mention the smaller TimesFM3 documentation update, but the title does not need to cover every change.
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 2 files.

Full details: Description check

Explanation

No pull request description was provided. The available objectives identify the Chronos2 documentation change, but the author did not provide a description that relates the changeset to the pull request.

Resolution

Add a brief description that summarizes the Chronos2 documentation updates and mentions the related TimesFM3 documentation change.

Finishing Touches
Generate docstrings
  • Commit to this branch
  • Create a new PR
Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

@codecov

codecov Bot commented Oct 31, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.39%. Comparing base (084aa7c) to head (59c1216).
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1320   +/-   ##
=======================================
  Coverage   82.39%   82.39%           
=======================================
  Files         185      185           
  Lines       11772    11772           
=======================================
  Hits         9700     9700           
  Misses       2072     2072           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

@rusty1s
rusty1s merged commit 863795a into main Oct 31, 2026
10 checks passed
@rusty1s
rusty1s deleted the chronos2-doc branch October 31, 2026 03:54
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.

1 participant