.github/ISSUE_TEMPLATE/bottleneck.md

In wlandau-lilly/drake: A Pipeline Toolkit for Reproducible Computation at Scale

name: Bottleneck about: drake is too slow or consumes too many resources. title: '' labels: 'topic: performance' assignees: wlandau

Prework

• [ ] Read and agree to the code of conduct and contributing guidelines.
• [ ] If there is already a relevant issue, whether open or closed, comment on the existing thread instead of posting a new issue.
• [ ] Post a minimal reproducible example so the maintainer can troubleshoot the problems you identify. A reproducible example is:
  • [ ] Runnable: post enough R code and data so any onlooker can create the error on their own computer.
  • [ ] Minimal: reduce runtime wherever possible and remove complicated details that are irrelevant to the issue at hand.
  • [ ] Readable: format your code according to the tidyverse style guide.

Description

Describe the bottleneck clearly and concisely.

Reproducible example

• [ ] Post a minimal reproducible example so the maintainer can troubleshoot the problems you identify. A reproducible example is:
  • [ ] Runnable: post enough R code and data so any onlooker can create the error on their own computer.
  • [ ] Minimal: reduce runtime wherever possible and remove complicated details that are irrelevant to the issue at hand.
  • [ ] Readable: format your code according to the tidyverse style guide.

Benchmarks

How poorly does drake perform? To find out, we recommend the proffer package and take screenshots of the results displayed in your browser.

library(drake)
library(proffer)
px <- pprof({
  # All your drake code goes here.
})

Alternatively, if installing proffer is too cumbersome, create a zip archive of profiling data (e.g. samples.zip below) and upload it to this issue thread.

Rprof(filename = "samples.rprof")
# Slow code goes here.
Rprof(NULL)
zip(zipfile = "samples.zip", files = "samples.rprof")

wlandau-lilly/drake documentation built on March 6, 2024, 8:18 a.m.