Document terminology & make it consistent throughout the code

zarr-developers / perfcapture

Capture the performance of a computer system whilst running a set of benchmark workloads.

MIT License

2 stars 2 forks source link

Document terminology & make it consistent throughout the code #9

Open JackKelly opened 1 year ago

JackKelly commented 1 year ago

Need to standardise on words like the "recipes", what's a single "run", etc.

Maybe a run should be a single execution of Workload.run() against a specific Dataset.

jmdelahanty commented 10 months ago

Is this the kind of thing that I could maybe contribute to? Since I'm so new to performance interrogation and efficient storage it might take me some time to understand, but I'm happy to try!

JackKelly commented 10 months ago

That's a very kind offer! TBH, this issue is more about reminding me use consistent names throughout the code (rather than a documentation issue). Sorry, I should've explained more in the original description!