feat: Process parameters

[toby-coleman]

Summary

Closes #97 by implementing process parameters, which are shared via the StateBackend with the components. This allows users to reuse configuration across many components without duplication in the config.

Changes

• Process parameters;
• Updates to component to retrieve parameters once connected to the backend;
• Update to Tuner to allow optimisation over process parameters;
• Updated example in documentation.

[gemini-code-assist]

Summary of Changes

Hello @toby-coleman, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request introduces the concept of "process parameters" to the Plugboard framework. This feature allows users to define a set of configuration parameters at the Process level, which are then automatically shared with and made accessible to all Component objects within that process. This significantly reduces configuration duplication, promotes reusability, and simplifies the management of common settings across multiple components in a workflow.

Highlights

• Introduction of Process Parameters: A new mechanism to define shared configuration values at the Process level, accessible by all Component objects.
• Parameter Merging Logic: Components now automatically merge process-level parameters with their own component-specific parameters, allowing for global defaults and local overrides.
• Updated Component Interface: The Component class now includes a parameters property and updated type hints for better clarity and usage.
• New Documentation and Examples: A new tutorial section and example files demonstrate how to effectively use process parameters in Plugboard workflows.
• Comprehensive Testing: An integration test has been added to verify the correct storage, retrieval, and merging behavior of process parameters within the StateBackend.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[github-actions]

Benchmark comparison for 6b392be0 (base) vs e75ba524 (PR)

------------------------------------------------------------------------------------------------------------------ benchmark: 2 tests -----------------------------------------------------------------------------------------------------------------
Name (time in ms)                                                                         Min                 Max                Mean            StdDev              Median               IQR            Outliers     OPS            Rounds  Iterations
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
test_benchmark_process_run (main/.benchmarks/Linux-CPython-3.12-64bit/0001_base)     361.5458 (1.0)      368.0466 (1.01)     364.8945 (1.00)     2.3210 (1.32)     364.9015 (1.00)     2.2796 (1.0)           2;0  2.7405 (1.00)          5           1
test_benchmark_process_run (pr/.benchmarks/Linux-CPython-3.12-64bit/0001_pr)         362.2626 (1.00)     365.9968 (1.0)      364.0617 (1.0)      1.7635 (1.0)      363.3294 (1.0)      3.2437 (1.42)          3;0  2.7468 (1.0)           5           1
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

Legend:
  Outliers: 1 Standard Deviation from Mean; 1.5 IQR (InterQuartile Range) from 1st Quartile and 3rd Quartile.
  OPS: Operations Per Second, computed as 1 / Mean

[gemini-code-assist]

Code Review

This pull request introduces process-level parameters that can be shared across components, which is a great feature for reusability. The implementation looks solid, including the logic for overriding parameters at the component level. My review includes a few suggestions to improve the examples in the documentation to better demonstrate the parameter override feature, and a suggestion to make the parameter merging logic in the Component class more robust against potential edge cases.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

[github-actions]

Benchmark comparison for 6b392be0 (base) vs 1d4fb29f (PR)

------------------------------------------------------------------------------------------------------------------ benchmark: 2 tests -----------------------------------------------------------------------------------------------------------------
Name (time in ms)                                                                         Min                 Max                Mean            StdDev              Median               IQR            Outliers     OPS            Rounds  Iterations
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
test_benchmark_process_run (main/.benchmarks/Linux-CPython-3.12-64bit/0001_base)     443.4942 (1.0)      451.6886 (1.0)      448.7467 (1.00)     3.5343 (1.0)      450.2940 (1.01)     5.5720 (1.51)          1;0  2.2284 (1.00)          5           1
test_benchmark_process_run (pr/.benchmarks/Linux-CPython-3.12-64bit/0001_pr)         445.6588 (1.00)     455.5470 (1.01)     448.2594 (1.0)      4.1453 (1.17)     446.3255 (1.0)      3.6961 (1.0)           1;1  2.2309 (1.0)           5           1
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

Legend:
  Outliers: 1 Standard Deviation from Mean; 1.5 IQR (InterQuartile Range) from 1st Quartile and 3rd Quartile.
  OPS: Operations Per Second, computed as 1 / Mean