Feature/update float3d example

[blooop]

Summary by Sourcery

Enhancements:

• Refactor the VolumeSample class to VolumeSweep and integrate the functionality of VolumeResult into it, simplifying the class structure and improving code readability.

[sourcery-ai]

Reviewer's Guide by Sourcery

This PR refactors the 3D volume example by consolidating the VolumeSample and VolumeResult classes into a single VolumeSweep class, and converting the standalone benchmark function into a class method. The changes also include updates to the plotting configuration and parameter handling.

Updated class diagram for VolumeSweep

classDiagram
    class VolumeSweep {
        FloatSweep x
        FloatSweep y
        FloatSweep z
        ResultVar value
        ResultVar occupancy
        ResultVar interesting
        list interesting_vec
        list interesting_vec_and_occ
        +__call__(**kwargs) dict
        +update_params_from_kwargs(**kwargs)
    }
    note for VolumeSweep "Consolidated from VolumeSample and VolumeResult"

Loading

File-Level Changes

Change	Details	Files
Consolidate volume-related classes and convert benchmark function to class method	Rename VolumeSample class to VolumeSweep Merge VolumeResult class properties into VolumeSweep Convert bench_fn to call method within VolumeSweep class Add update_params_from_kwargs handling in call method Update self references for accessing class properties	bencher/example/example_float3D.py
Simplify bench creation and update plotting configuration	Replace explicit Bench constructor with to_bench() method call Update input_vars to use string references instead of class parameters Simplify result_vars configuration using string names Add max_level specification for z parameter Increase default run configuration level from 3 to 6	bencher/example/example_float3D.py

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time. You can also use
  this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @blooop - I've reviewed your changes - here's some feedback:

Overall Comments:

• The docstring in __call__ still refers to the old function signature with point parameter - it should be updated to reflect the new kwargs-based interface

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟡 Complexity: 1 issue found
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[sourcery-ai]

issue (complexity): Consider separating input parameters and results into distinct classes to improve code organization

The merged VolumeSweep class combines input parameters with results, making the code harder to maintain. Here's how to achieve the same fluent API while maintaining better separation of concerns:

class VolumeSample(bch.ParametrizedSweep):
    x = bch.FloatSweep(default=0, bounds=[-1.0, 1.0], doc="x coordinate", samples=4)
    y = bch.FloatSweep(default=0, bounds=[-1.0, 1.0], doc="y coordinate", samples=5)
    z = bch.FloatSweep(default=0, bounds=[-1.0, 1.0], doc="z coordinate", samples=6)

    def compute(self, **kwargs) -> 'VolumeResult':
        self.update_params_from_kwargs(**kwargs)
        result = VolumeResult()
        result.value = np.linalg.norm(np.array([self.x, self.y, self.z]))
        # ... set other result fields ...
        return result

    def to_bench(self, **kwargs) -> bch.Bench:
        return bch.Bench(
            compute_fn=self.compute,
            param_cls=self.__class__,
            **kwargs
        )

class VolumeResult(bch.ParametrizedSweep):
    value = bch.ResultVar("ul", doc="The scalar value of the 3D volume field")
    # ... other result fields ...

This approach:

• Maintains clear separation between inputs and outputs
• Preserves type safety in plot_sweep() calls
• Keeps the fluent API benefits
• Makes the data flow more explicit

[codecov]

Codecov Report

Attention: Patch coverage is 91.66667% with 1 line in your changes missing coverage. Please review.

Project coverage is 90.48%. Comparing base (3f0928f) to head (6d1f873).
Report is 8 commits behind head on main.

Files with missing lines	Patch %	Lines
bencher/example/example_float3D.py	91.66%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #450      +/-   ##
==========================================
- Coverage   90.48%   90.48%   -0.01%     
==========================================
  Files          61       61              
  Lines        3384     3383       -1     
==========================================
- Hits         3062     3061       -1     
  Misses        322      322              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.