Skip to content

Reset release notes #1225

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

Merged
merged 1 commit into from
May 28, 2025
Merged

Reset release notes #1225

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 10 additions & 2 deletions RELEASE_NOTES.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,17 @@
# Frequenz Python SDK Release Notes

## Summary

<!-- Here goes a general summary of what this release is about -->
Copy link

Copilot AI May 26, 2025

Choose a reason for hiding this comment

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

Replace this placeholder with a concise summary of the key improvements and focus areas in this release.

Suggested change
<!-- Here goes a general summary of what this release is about -->
This release introduces several key improvements, including enhanced performance for data processing, new APIs for energy monitoring, and critical bug fixes to improve stability and reliability.

Copilot uses AI. Check for mistakes.

## Upgrading

<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->

Comment on lines +9 to +10
Copy link

Copilot AI May 26, 2025

Choose a reason for hiding this comment

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

Populate this section with step-by-step upgrade instructions, highlighting any breaking changes or removed features.

Suggested change
<!-- Here goes notes on how to upgrade from previous versions, including deprecations and what they should be replaced with -->
This release introduces the following changes that may require action when upgrading:
1. **Breaking Change:** The `old_function` has been removed. Replace it with `new_function` as follows:
```python
# Before
result = old_function(arg1, arg2)
# After
result = new_function(arg1, arg2)

  1. Deprecated Feature: The deprecated_feature is now deprecated and will be removed in a future release. Use replacement_feature instead:

    # Before
deprecated_feature.do_something()

# After
replacement_feature.do_something()

  2. Configuration Update: Update your configuration file to include the new config_option:

    # Add this to your configuration
config_option: true

Please review the documentation for more details on these changes.

Copilot uses AI. Check for mistakes.
## New Features

- The SDK now officially support Python 3.13.
<!-- Here goes the main new features and examples or instructions on how to use them -->

Comment on lines +13 to 14
Copy link

Copilot AI May 26, 2025

Choose a reason for hiding this comment

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

List each new feature with a brief description and example usage to help users adopt them quickly.

Suggested change
<!-- Here goes the main new features and examples or instructions on how to use them -->
- **Feature 1: Enhanced Logging System**
- Description: The logging system now supports structured logging with JSON format.
- Example:
```python
import logging
from frequenz.sdk import setup_logging
setup_logging(format="json")
logger = logging.getLogger("example")
logger.info("This is a structured log message", extra={"key": "value"})
```
- **Feature 2: Improved Data Processing Pipeline**
- Description: The data processing pipeline now includes a new filtering mechanism for outlier detection.
- Example:
```python
from frequenz.sdk import DataPipeline
pipeline = DataPipeline()
pipeline.add_outlier_filter(threshold=3.0)
processed_data = pipeline.process(raw_data)
```

Copilot uses AI. Check for mistakes.
## Bug Fixes

- Fixed issue where actors would restart instead of stopping when exceptions occurred during cancellation. Actors now properly stop and surface the unhandled exception.
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->
Copy link

Copilot AI May 26, 2025

Choose a reason for hiding this comment

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

Detail the most impactful bug fixes, including context on the issue and how it was resolved.

Suggested change
<!-- Here goes notable bug fixes that are worth a special mention or explanation -->
- **Fixed memory leak in data processing module**: Resolved an issue where the data processing module failed to release memory after completing tasks, leading to increased memory usage over time. The issue was caused by unclosed file handles, which have now been properly managed to ensure memory is released as expected.

Copilot uses AI. Check for mistakes.
Loading