Skip to content

Commit

Permalink
Clear release notes (#111)
Browse files Browse the repository at this point in the history
  • Loading branch information
llucax committed Dec 9, 2022
2 parents d04a7dd + 44a7211 commit 2c110b0
Showing 1 changed file with 4 additions and 13 deletions.
17 changes: 4 additions & 13 deletions RELEASE_NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,25 +2,16 @@

## Summary

This release improves the performance of the `ComponentMetricsResamplingActor`, and fixes a bug in the `LogicalMeter` that was causing it to crash.
<!-- Here goes a general summary of what this release is about -->

## Upgrading

- `frequenz.sdk.timseries`:
- The resample classes (`GroupResampler`, `Resampler`, `ResamplingFunction`) where removed and the replacement classes are hidden for now, as they are going through a rewrite.
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->

## New Features

- New in `frequenz.sdk.timeseries`:

- `Source` and `Sink` types to work generically with streaming timeseries.

- New `frequenz.sdk.timeseries.resampling` module with:
- `Resampler` class that works on timseries `Source` and `Sink`.
- `ResamplingFunction` (moved from `frequenz.sdk.timeseries`).
- `ResamplingError` and `SourceStoppedError` exceptions.
- `average` function (the default resampling function).
<!-- Here goes the main new features and examples or instructions on how to use them -->

## Bug Fixes

- The Resampling actor sends None values out when there is no data from a component. The logical meter used to raise an exception if it saw a `None` value from any of its streams. The logical meter is now able to handle `None` values by propagating the `None` values, or treating them as `0`s.
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->

0 comments on commit 2c110b0

Please sign in to comment.