Skip to content

chore: migrate gift-eval module - #369

Open
AzulGarza wants to merge 6 commits into
mainfrom
chore/gift-eval-migration
Open

chore: migrate gift-eval module#369
AzulGarza wants to merge 6 commits into
mainfrom
chore/gift-eval-migration

Conversation

@AzulGarza

Copy link
Copy Markdown
Member

this pr migrates the gift-eval module that lived in the repo. now users can directly access it using timecopilot-gift-eval

Copilot AI lite review requested due to automatic review settings August 14, 2026 19:26
@cursor

cursor Bot commented Aug 14, 2026

Copy link
Copy Markdown

Bugbot is not enabled for your account, so this pull request was not reviewed.

Enable Bugbot in the Cursor dashboard to get automatic reviews on future PRs.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Migrates the in-repo timecopilot.gift_eval implementation to the standalone PyPI package timecopilot-gift-eval, updating dependencies and all internal references so users can access the functionality via timecopilot_gift_eval / the timecopilot[gift-eval] extra.

Changes:

  • Add timecopilot-gift-eval>=0.3.0 as an optional extra (gift-eval) and include it in dev/docs dependencies.
  • Remove the in-repo timecopilot/gift_eval implementation files and update tests/experiments/docs to import from timecopilot_gift_eval.
  • Update lockfile(s) and documentation to reflect the new distribution/import paths.

Reviewed changes

Copilot reviewed 15 out of 18 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
uv.lock Adds the gift-eval extra and locks timecopilot-gift-eval==0.3.0 into dev/docs and optional dependency metadata.
pyproject.toml Introduces gift-eval optional dependency and installs timecopilot-gift-eval for dev/docs environments.
timecopilot/gift_eval/utils.py Removed (module migrated out of repo).
timecopilot/gift_eval/gluonts_predictor.py Removed (module migrated out of repo).
timecopilot/gift_eval/eval.py Removed (module migrated out of repo).
timecopilot/gift_eval/data.py Removed (module migrated out of repo).
tests/gift_eval/test_gift_eval.py Switches imports to timecopilot_gift_eval and cleans up test output.
tests/gift_eval/test_evaluation.py Switches imports to timecopilot_gift_eval and adjusts which columns are compared to the reference results.
tests/gift_eval/conftest.py Uses GIFTEval from timecopilot_gift_eval for fixtures (data download + reference CSV caching).
mkdocs.yml Preloads timecopilot_gift_eval for API docs generation.
experiments/gift-eval/src/run_timecopilot.py Updates imports to the external timecopilot_gift_eval package.
experiments/gift-eval/src/run_modal.py Updates dataset-term import to timecopilot_gift_eval.utils.
experiments/gift-eval/src/download_results.py Updates dataset-term import to timecopilot_gift_eval.utils.
experiments/gift-eval/pyproject.toml Renames the experiments project and depends on timecopilot-gift-eval>=0.3.0.
docs/examples/gift-eval.ipynb Updates installation instructions and imports/links to the new timecopilot_gift_eval path.
docs/api/gift-eval/gift-eval.md Documents the new standalone package and updates mkdocstrings targets to timecopilot_gift_eval.*.

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread tests/gift_eval/test_evaluation.py Outdated

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 15 out of 18 changed files in this pull request and generated 1 comment.

Suppressed comments (2)

docs/examples/gift-eval.ipynb:791

  • Spelling: “mantainers” should be “maintainers”.
    "The TimeCopilot's [GIFT-Eval integration](https://timecopilot.dev/api/gift-eval/gift-eval/#timecopilot_gift_eval.eval.GIFTEval) was designed considering reproducibility as one of its main features. The library can replicate the official results provided by the mantainers of the benchmark for the [`SeasonalNaive`](https://huggingface.co/spaces/Salesforce/GIFT-Eval/tree/main/results/seasonal_naive) method. The following code replicates the Seasonal Naive performance for the datasets evaluated in this notebook. The reproducibility of the results for the rest of the datasets are tested continuously in the [library's repo](https://github.com/TimeCopilot/timecopilot/blob/main/tests/gift_eval/test_evaluation.py)."

docs/api/gift-eval/gift-eval.md:3

  • This page introduces the new timecopilot_gift_eval import path, but it doesn’t explicitly mention that earlier docs/examples used timecopilot.gift_eval. Adding a brief migration note here would reduce confusion for existing users following older snippets (e.g., changelogs still reference timecopilot.gift_eval).
GIFT-Eval integration lives in the standalone [`timecopilot-gift-eval`](https://pypi.org/project/timecopilot-gift-eval/) package on PyPI. Install it with TimeCopilot via:

Comment thread pyproject.toml
Comment on lines +119 to +121
gift-eval = [
"timecopilot-gift-eval>=0.3.0",
]
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.

2 participants