Skip to content
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

Add small parameter representation guide for the benchmark runner #141

Open
nicholasjng opened this issue Apr 2, 2024 · 0 comments
Open
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Milestone

Comments

@nicholasjng
Copy link
Collaborator

We recently changed the way parameters are injected into the benchmark records. All Python-native types and containers thereof are passing unchanged, but user-defined types are serialized to string (their repr() outputs to be exact), which can be surprising.

Since we do not yet mention this anywhere in the docs, we could set up a small section on this practice, and recommend a way to handle types for best odds of reproducibility (e.g. dumping unique information into the output, or overloading the repr() method to give all unique info).

@nicholasjng nicholasjng added documentation Improvements or additions to documentation enhancement New feature or request labels Apr 2, 2024
@nicholasjng nicholasjng added this to the v0.4.0 milestone Apr 2, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant