Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: release v0.8.0 #218

Closed
wants to merge 2 commits into from
Closed

chore: release v0.8.0 #218

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e1ae551
chore: release v0.8.0
sd2k Dec 23, 2024
0fbdc50
Add references to migration guide to CHANGELOGs
sd2k Dec 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ authors = [
]
documentation = "https://docs.rs/crate/augurs"
repository = "https://github.com/grafana/augurs"
version = "0.7.0"
version = "0.8.0"
edition = "2021"
keywords = [
"analysis",
Expand All @@ -29,16 +29,16 @@ keywords = [

[workspace.dependencies]
augurs = { path = "crates/augurs" }
augurs-changepoint = { version = "0.7.0", path = "crates/augurs-changepoint" }
augurs-clustering = { version = "0.7.0", path = "crates/augurs-clustering" }
augurs-core = { version = "0.7.0", path = "crates/augurs-core" }
augurs-dtw = { version = "0.7.0", path = "crates/augurs-dtw" }
augurs-ets = { version = "0.7.0", path = "crates/augurs-ets" }
augurs-forecaster = { version = "0.7.0", path = "crates/augurs-forecaster" }
augurs-mstl = { version = "0.7.0", path = "crates/augurs-mstl" }
augurs-outlier = { version = "0.7.0", path = "crates/augurs-outlier" }
augurs-prophet = { version = "0.7.0", path = "crates/augurs-prophet" }
augurs-seasons = { version = "0.7.0", path = "crates/augurs-seasons" }
augurs-changepoint = { version = "0.8.0", path = "crates/augurs-changepoint" }
augurs-clustering = { version = "0.8.0", path = "crates/augurs-clustering" }
augurs-core = { version = "0.8.0", path = "crates/augurs-core" }
augurs-dtw = { version = "0.8.0", path = "crates/augurs-dtw" }
augurs-ets = { version = "0.8.0", path = "crates/augurs-ets" }
augurs-forecaster = { version = "0.8.0", path = "crates/augurs-forecaster" }
augurs-mstl = { version = "0.8.0", path = "crates/augurs-mstl" }
augurs-outlier = { version = "0.8.0", path = "crates/augurs-outlier" }
augurs-prophet = { version = "0.8.0", path = "crates/augurs-prophet" }
augurs-seasons = { version = "0.8.0", path = "crates/augurs-seasons" }
augurs-testing = { path = "crates/augurs-testing" }

augurs-core-js = { path = "js/augurs-core-js" }
Expand Down
6 changes: 6 additions & 0 deletions crates/augurs-core/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [0.8.0](https://github.com/grafana/augurs/compare/augurs-core-v0.7.0...augurs-core-v0.8.0) - 2024-12-23

### Added

- [**breaking**] switch `transform` to a trait (#213)

## [0.5.1](https://github.com/grafana/augurs/compare/augurs-core-v0.5.0...augurs-core-v0.5.1) - 2024-10-24

### Other
Expand Down
24 changes: 24 additions & 0 deletions crates/augurs-forecaster/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,32 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [0.8.0](https://github.com/grafana/augurs/compare/augurs-forecaster-v0.7.0...augurs-forecaster-v0.8.0) - 2024-12-23

This release includes some major, breaking changes to the `augurs-forecaster` crate. See the [migration guide](https://docs.augu.rs/migrating.html#from-07-to-08) for more information on how to upgrade.

### Added

- [**breaking**] switch `transform` to a trait (#213)
- allow creating a Box-Cox or Yeo-Johnson transform with either lambda or data (#212)
- add standard scaler transform (#204)
- add 'transforms' JS crate and include in augurs JS bindings (#195)

### Fixed

- use box_cox instead of boxcox (#203)
- make Transform enum non-exhaustive (#194)

### Other

- restructure transforms into modules (#210)
- precalculate offset and scale factor for min-max scale transformer (#196)
- Add power transformation logic to forecaster transforms ([#185](https://github.com/grafana/augurs/pull/185))

## [0.7.0](https://github.com/grafana/augurs/compare/augurs-forecaster-v0.6.3...augurs-forecaster-v0.7.0) - 2024-11-25

This release includes some major, breaking changes to how holidays are handled in Prophet. See the [migration guide](https://docs.augu.rs/migrating.html#from-06-to-07) for more information on how to upgrade.

### Other

- update Cargo.toml dependencies
Expand Down
6 changes: 6 additions & 0 deletions crates/augurs-outlier/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [0.8.0](https://github.com/grafana/augurs/compare/augurs-outlier-v0.7.0...augurs-outlier-v0.8.0) - 2024-12-23

### Other

- *(deps)* update rv requirement from 0.17.0 to 0.18.0 (#198)

## [0.7.0](https://github.com/grafana/augurs/compare/augurs-outlier-v0.6.3...augurs-outlier-v0.7.0) - 2024-11-25

### Other
Expand Down
19 changes: 19 additions & 0 deletions crates/augurs-prophet/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,27 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [0.8.0](https://github.com/grafana/augurs/compare/augurs-prophet-v0.7.0...augurs-prophet-v0.8.0) - 2024-12-23

### Added

- add Forecaster wrapper for Prophet (#191)
Copy link
Contributor

Choose a reason for hiding this comment

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

💡 Codebase verification

Documentation needs improvement for the Forecaster wrapper

Based on the verification results, while there is a working example in examples/forecasting/examples/prophet_forecaster.rs and some API documentation in the source code, the Forecaster wrapper functionality needs better documentation:

  • The main README focuses on the Prophet model but doesn't mention the Forecaster wrapper
  • The implementation has inline documentation but lacks comprehensive usage guidelines
  • Key features like transformation capabilities are only shown in examples

Suggested documentation additions:

  • Add a dedicated section in README.md about the Forecaster wrapper
  • Document integration with the augurs framework
  • Explain the transformation pipeline capabilities
  • Provide clear examples of prediction interval generation
🔗 Analysis chain

Document the Forecaster wrapper functionality

The addition of the Forecaster wrapper for Prophet should include:

  • Basic usage examples
  • Key features and capabilities
  • Integration guidelines

Let's check for existing documentation:

Let me check the example and documentation content in more detail:

Let me check if there's any additional documentation in the README or other documentation files:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for Forecaster wrapper documentation
rg -g '!target' -g '*.{md,rs}' -i 'forecaster.*wrapper|prophet.*forecaster'

Length of output: 2234

Script:

#!/bin/bash
# Check the example content
cat examples/forecasting/examples/prophet_forecaster.rs

# Check the implementation documentation
cat crates/augurs-prophet/src/forecaster.rs

Length of output: 8989

Script:

#!/bin/bash
# Check README and other potential documentation
cat crates/augurs-prophet/README.md 2>/dev/null || true
cat crates/augurs-prophet/src/lib.rs 2>/dev/null || true

Length of output: 9016


### Fixed

- *(docs)* fix incorrect link to chrono
- add explicit link to chrono method (#192)

### Other

- *(deps)* update wasmtime requirement from 27 to 28 (#216)
- Commit prophet-wasmstan.wasm to git ([#206](https://github.com/grafana/augurs/pull/206))
- *(deps)* update statrs requirement from 0.17.1 to 0.18.0 (#187)

## [0.7.0](https://github.com/grafana/augurs/compare/augurs-prophet-v0.6.3...augurs-prophet-v0.7.0) - 2024-11-25

This release includes some major, breaking changes to how holidays are handled. See the [migration guide](https://docs.augu.rs/migrating.html#from-06-to-07) for more information on how to upgrade.

### Breaking Changes

- Support sub-daily & non-UTC holidays ([#181](https://github.com/grafana/augurs/pull/181))
Expand Down
8 changes: 8 additions & 0 deletions crates/augurs/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [0.8.0](https://github.com/grafana/augurs/compare/augurs-v0.7.0...augurs-v0.8.0) - 2024-12-23

This release includes some major, breaking changes to the `augurs-forecaster` crate (and the `forecaster` feature of the `augurs` crate). See the [migration guide](https://docs.augu.rs/migrating.html#from-07-to-08) for more information on how to upgrade.

### Added

- [**breaking**] switch `transform` to a trait (#213)
Comment on lines +14 to +16
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Document all breaking changes mentioned in PR objectives.

The changelog only mentions the transform trait change, but the PR objectives indicate additional breaking changes in augurs-core and augurs-forecaster, including removal/renaming of public modules, structs, traits, and enums.

Add these breaking changes to maintain a comprehensive changelog:

 ### Added
 
 - [**breaking**] switch `transform` to a trait (#213)
+
+### Removed
+
+- [**breaking**] removed/renamed public modules in augurs-core
+- [**breaking**] removed/renamed structs, traits, and enums in augurs-forecaster
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
### Added
- [**breaking**] switch `transform` to a trait (#213)
### Added
- [**breaking**] switch `transform` to a trait (#213)
### Removed
- [**breaking**] removed/renamed public modules in augurs-core
- [**breaking**] removed/renamed structs, traits, and enums in augurs-forecaster


## [0.6.0](https://github.com/grafana/augurs/compare/augurs-v0.5.4...augurs-v0.6.0) - 2024-11-08

### Added
Expand Down
Loading