Skip to content

Python: Support callers passing in max supersteps for processes #11798

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.

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

Conversation

moonbox3
Copy link
Contributor

Motivation and Context

Today in Python processes the max_supersteps config is hidden from the caller. The internal execute method defaults the value to 100, and this doesn't allow for developers to leverage custom values depending on their use cases.

Description

Provide a way for callers to pass in max_supersteps via the process runtime start method.

  • Update README
  • Update unit tests accordingly.

Contribution Checklist

@moonbox3 moonbox3 self-assigned this Apr 29, 2025
@moonbox3 moonbox3 requested a review from a team as a code owner April 29, 2025 05:21
@markwallace-microsoft markwallace-microsoft added python Pull requests for the Python Semantic Kernel documentation labels Apr 29, 2025
@moonbox3 moonbox3 requested a review from Copilot April 29, 2025 05:23
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR enables callers to specify a custom value for max_supersteps, allowing more flexible control over process execution. Key changes include:

  • Adding tests to validate the custom max_supersteps configuration.
  • Updating both local and Dapr runtime process contexts and processes to accept and propagate the max_supersteps parameter.
  • Enhancing documentation to describe how to configure max_supersteps.

Reviewed Changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated no comments.

Show a summary per file
File Description
python/tests/unit/processes/local_runtime/test_local_process.py Added test to validate max_supersteps initialization.
python/tests/unit/processes/dapr_runtime/test_dapr_kernel_process_context.py Updated expected payload to include max_supersteps.
python/tests/unit/processes/dapr_runtime/test_dapr_kernel_process.py Modified tests to pass and assert max_supersteps.
python/semantic_kernel/processes/local_runtime/local_process.py Updated init and start to accept and use max_supersteps.
python/semantic_kernel/processes/local_runtime/local_kernel_process_context.py Propagated max_supersteps to LocalProcess.
python/semantic_kernel/processes/local_runtime/local_kernel_process.py Extended start function to accept max_supersteps and pass it to the context.
python/semantic_kernel/processes/dapr_runtime/dapr_kernel_process_context.py Modified init and start_with_event to support max_supersteps.
python/semantic_kernel/processes/dapr_runtime/dapr_kernel_process.py Updated start function to relay max_supersteps.
python/semantic_kernel/processes/dapr_runtime/actors/process_actor.py Adjusted actor initialization and internal execution for max_supersteps.
python/samples/getting_started_with_processes/README.md Documented configuration and usage of max_supersteps.

@markwallace-microsoft
Copy link
Member

markwallace-microsoft commented Apr 29, 2025

Python Unit Test Overview

Tests Skipped Failures Errors Time
3471 5 💤 0 ❌ 0 🔥 1m 43s ⏱️

@eavanvalkenburg eavanvalkenburg force-pushed the py-processes-max-super-step branch from 3697675 to 21ebb64 Compare April 30, 2025 08:57
@eavanvalkenburg eavanvalkenburg added this pull request to the merge queue Apr 30, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Apr 30, 2025
@eavanvalkenburg eavanvalkenburg added this pull request to the merge queue Apr 30, 2025
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Apr 30, 2025
@eavanvalkenburg eavanvalkenburg added this pull request to the merge queue Apr 30, 2025
Merged via the queue into microsoft:main with commit d3404cc Apr 30, 2025
28 checks passed
@github-project-automation github-project-automation bot moved this to Sprint: Done in Semantic Kernel Apr 30, 2025
glorious-beard pushed a commit to glorious-beard/semantic-kernel that referenced this pull request May 6, 2025
…osoft#11798)

### Motivation and Context

Today in Python processes the `max_supersteps` config is hidden from the
caller. The internal execute method defaults the value to 100, and this
doesn't allow for developers to leverage custom values depending on
their use cases.

<!-- Thank you for your contribution to the semantic-kernel repo!
Please help reviewers and future users, providing the following
information:
  1. Why is this change required?
  2. What problem does it solve?
  3. What scenario does it contribute to?
  4. If it fixes an open issue, please link to the issue here.
-->

### Description

Provide a way for callers to pass in `max_supersteps` via the process
runtime `start` method.
- Update README
- Update unit tests accordingly. 

<!-- Describe your changes, the overall approach, the underlying design.
These notes will help understanding how your code works. Thanks! -->

### Contribution Checklist

<!-- Before submitting this PR, please make sure: -->

- [X] The code builds clean without any errors or warnings
- [X] The PR follows the [SK Contribution
Guidelines](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md)
and the [pre-submission formatting
script](https://github.com/microsoft/semantic-kernel/blob/main/CONTRIBUTING.md#development-scripts)
raises no violations
- [X] All unit tests pass, and I have added new tests where possible
- [X] I didn't break anyone 😄
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation processes python Pull requests for the Python Semantic Kernel
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants