release: v0.0.17 (#205)

Author: AzulGarza

docs/changelogs/index.md

@@ -3,6 +3,7 @@
 Welcome to the TimeCopilot Changelog. Here, you will find a comprehensive list of all the changes, updates, and improvements made to the TimeCopilot project. This section is designed to keep you informed about the latest features, bug fixes, and enhancements as we continue to develop and refine the TimeCopilot experience. Stay tuned for regular updates and feel free to explore the details of each release below.
 
 
+- [v0.0.17](v0.0.17.md)
 - [v0.0.16](v0.0.16.md)
 - [v0.0.15](v0.0.15.md)
 - [v0.0.14](v0.0.14.md)

docs/changelogs/v0.0.17.md

@@ -0,0 +1,96 @@
+### Features
+
+* **Moirai2 Foundation Model**: Added support for the [Moirai2](https://github.com/SalesforceAIResearch/uni2ts) model, a new state-of-the-art foundation model for time series forecasting. See [#177](https://github.com/AzulGarza/timecopilot/pull/177).
+
+    ```python
+    import pandas as pd
+    from timecopilot.models.foundation.moirai import Moirai
+
+    df = pd.read_csv(
+        "https://timecopilot.s3.amazonaws.com/public/data/air_passengers.csv", 
+        parse_dates=["ds"]
+    )
+    model = Moirai(repo_id="Salesforce/moirai-2.0-R-small")
+    fcst = model.forecast(df, h=12)
+    print(fcst)
+    ```
+
+* **Machine Learning and Neural Forecasting Methods**: Expanded the forecasting capabilities with new ML and neural methods including `AutoLightGBM`, `AutoNHITS` y `AutoTFT`. See [#181](https://github.com/AzulGarza/timecopilot/pull/181).
+
+* **Static Plot Method**: Added a static plotting method for visualizing forecasts without requiring an agent instance. See [#183](https://github.com/AzulGarza/timecopilot/pull/183).
+
+    ```python
+    import pandas as pd
+    from timecopilot import TimeCopilotForecaster
+    from timecopilot.models.foundation.moirai import Moirai
+    from timecopilot.models.prophet import Prophet
+    from timecopilot.models.stats import AutoARIMA, AutoETS, SeasonalNaive
+
+    df = pd.read_csv(
+        "https://timecopilot.s3.amazonaws.com/public/data/air_passengers.csv",
+        parse_dates=["ds"],
+    )
+    tcf = TimeCopilotForecaster(
+        models=[
+            AutoARIMA(), 
+            AutoETS(), 
+            Moirai(), 
+            Prophet(), 
+            SeasonalNaive(),
+        ]
+    )
+    fcst_df = tcf.forecast(df=df, h=12, level=[80, 90])
+    tcf.plot(df, fcst_df, level=[80, 90])
+    ```
+
+* **Enhanced Documentation with Examples**: Added comprehensive examples section using mkdocs-jupyter, including interactive notebooks for [agent quickstart](https://timecopilot.dev/examples/agent-quickstart/) and [forecaster usage](https://timecopilot.dev/examples/forecaster-quickstart/). See [#176](https://github.com/AzulGarza/timecopilot/pull/176) and [#198](https://github.com/AzulGarza/timecopilot/pull/198).
+
+* **GIFT-Eval Plotting**: Added plots for the [GIFT-Eval experiment](https://timecopilot.dev/experiments/gift-eval/) to better visualize model performance across different datasets. See [#180](https://github.com/AzulGarza/timecopilot/pull/180).
+
+* **Improved Date and Target Column Handling**: Specify to the agent the handling of date (`ds`) and target (`y`) columns. See [#139](https://github.com/AzulGarza/timecopilot/pull/139).
+
+### Refactorings
+
+* **Clearer Models Structure**: Reorganized the models module for better clarity and maintainability. Models are now organized into logical categories: `stats`, `ml`, `neural`, `foundation`, and `ensembles`. See [#203](https://github.com/AzulGarza/timecopilot/pull/203).
+    - Prophet moved from `models.benchmarks.prophet` to `models.prophet`
+    - Statistical models moved from `models.benchmarks.stats` to `models.stats`
+    - ML models moved from `models.benchmarks.ml` to `models.ml`
+    - Neural models moved from `models.benchmarks.neural` to `models.neural`
+
+* **Improved DataFrame Concatenation**: Optimized DataFrame concatenation in feature extraction loops for better performance. See [#105](https://github.com/AzulGarza/timecopilot/pull/105).
+
+### Fixes
+
+* **OpenAI Version Compatibility**: Unpinned OpenAI version to resolve compatibility issues with recent releases. See [#171](https://github.com/AzulGarza/timecopilot/pull/171).
+
+* **Median Ensemble Level Test**: Relaxed test constraints for median ensemble levels to improve test reliability. See [#175](https://github.com/AzulGarza/timecopilot/pull/175).
+
+* **Documentation URL Format**: Updated documentation to use kebab-case URLs for better consistency. See [#200](https://github.com/AzulGarza/timecopilot/pull/200).
+
+* **Explicit Keyword Arguments**: Added explicit override handling for keyword arguments to prevent unexpected behavior. See [#202](https://github.com/AzulGarza/timecopilot/pull/202).
+
+### Documentation
+
+* **Enhanced README**: Improved README content with additional information and fixed various typos. See [#172](https://github.com/AzulGarza/timecopilot/pull/172), [#187](https://github.com/AzulGarza/timecopilot/pull/187), [#188](https://github.com/AzulGarza/timecopilot/pull/188).
+
+* **New Logo and Branding**: Added new logos and favicon for improved visual identity. See [#185](https://github.com/AzulGarza/timecopilot/pull/185), [#186](https://github.com/AzulGarza/timecopilot/pull/186).
+
+* **Issue Templates**: Added GitHub issue templates to streamline bug reporting and feature requests. See [#193](https://github.com/AzulGarza/timecopilot/pull/193).
+
+* **Documentation Testing**: Added comprehensive tests for documentation to ensure code examples work correctly. See [#194](https://github.com/AzulGarza/timecopilot/pull/194).
+
+### Infrastructure
+
+* **CI/CD Improvements**: Moved linting action to the main CI workflow for better organization. See [#174](https://github.com/AzulGarza/timecopilot/pull/174).
+
+* **Discord Release Notifications**: Added automated Discord notifications for new releases. See [#195](https://github.com/AzulGarza/timecopilot/pull/195), [#196](https://github.com/AzulGarza/timecopilot/pull/196), [#197](https://github.com/AzulGarza/timecopilot/pull/197).
+
+* **Improved Experiment Naming**: Better naming conventions for GIFT-Eval experiments. See [#199](https://github.com/AzulGarza/timecopilot/pull/199).
+
+## New Contributors
+* @elmartinj made their first contribution in [#187](https://github.com/AzulGarza/timecopilot/pull/187)
+* @friscobrisco made their first contribution in [#139](https://github.com/AzulGarza/timecopilot/pull/139)
+
+---
+
+**Full Changelog**: https://github.com/AzulGarza/timecopilot/compare/v0.0.16...v0.0.17

mkdocs.yml

@@ -40,6 +40,7 @@ nav:
       - api/gift-eval/gift-eval.md
   - Changelogs:
       - changelogs/index.md
+      - changelogs/v0.0.17.md
       - changelogs/v0.0.16.md
       - changelogs/v0.0.15.md
       - changelogs/v0.0.14.md

pyproject.toml

@@ -73,7 +73,7 @@ license = "MIT"
 name = "timecopilot"
 readme = "README.md"
 requires-python = ">=3.10"
-version = "0.0.16"
+version = "0.0.17"
 
 [project.scripts]
 timecopilot = "timecopilot._cli:main"