Expose code blocks in replication and explain REPL usage #395
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Benchmark resultJudge resultBenchmark Report for /home/runner/work/Rt-without-renewal/Rt-without-renewalJob Properties
ResultsA ratio greater than
Benchmark Group ListHere's a list of all the benchmark groups executed by this job:
Julia versioninfoTargetBaselineTarget resultBenchmark Report for /home/runner/work/Rt-without-renewal/Rt-without-renewalJob Properties
ResultsBelow is a table of this job's results, obtained by running the benchmarks.
Benchmark Group ListHere's a list of all the benchmark groups executed by this job:
Julia versioninfoBaseline resultBenchmark Report for /home/runner/work/Rt-without-renewal/Rt-without-renewalJob Properties
ResultsBelow is a table of this job's results, obtained by running the benchmarks.
Benchmark Group ListHere's a list of all the benchmark groups executed by this job:
Julia versioninfoRuntime information
|
There was a problem hiding this comment.
General comment is I am curious how I would run this vignette outside the root of the repo, as I had tried in my sandbox yesterday after installing the package. For me, this is typically how I gain familiarity with a new package, I will try to work with it in a separate scratch repo somewhere. But if the idea is more to work within this repo and load EpiAware, as long as it is clear to users how they could do this from their own project repo I think that's fine!
|
These are really good points. So eventually |
This should work too. You'll need add any other dependencies, but it should work without pinning to specific version. If you could test that out, that would be great. |
Because once it's on Julia registry, does the environment management that you have set up here:
Set this up automatically? |
seabbs
reviewed
Jul 23, 2024
There was a problem hiding this comment.
Nice changes but overall I think we want to aim for plug and play (i.e copy and paste interaction) and not requiring a local clone or any mucking about with our environments or local package.
I think either:
- People use it as a pluto notebook and we have instructions for them
- People copy and paste into their local instance.
I think those instructions should be in a central doc and we should aim to have as little boiler plate as possible in each doc.
|
Responding to the rest of the convo here all the current instructions etc just seem overly complicated and hacky. All we need is to show people what the dependencies are of a given tutorial in a block and let them install them via copying and pasting imo. |
seabbs
reviewed
Jul 23, 2024
Agreed. I'd independently come to that view as well and just pushed this change. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #395 +/- ##
=======================================
Coverage 93.33% 93.33%
=======================================
Files 53 53
Lines 540 540
=======================================
Hits 504 504
Misses 36 36 ☔ View full report in Codecov by Sentry. |
|
What I've done is to put the information about Pluto code blocks into FAQ, and the extra details about what env we want to use and checking out the branch version of EpiAware into developer docs. I think this should be usable/readable now. |
Benchmark resultJudge resultBenchmark Report for /home/runner/work/Rt-without-renewal/Rt-without-renewalJob Properties
ResultsA ratio greater than
Benchmark Group ListHere's a list of all the benchmark groups executed by this job:
Julia versioninfoTargetBaselineTarget resultBenchmark Report for /home/runner/work/Rt-without-renewal/Rt-without-renewalJob Properties
ResultsBelow is a table of this job's results, obtained by running the benchmarks.
Benchmark Group ListHere's a list of all the benchmark groups executed by this job:
Julia versioninfoBaseline resultBenchmark Report for /home/runner/work/Rt-without-renewal/Rt-without-renewalJob Properties
ResultsBelow is a table of this job's results, obtained by running the benchmarks.
Benchmark Group ListHere's a list of all the benchmark groups executed by this job:
Julia versioninfoRuntime information
|
Benchmark resultJudge resultBenchmark Report for /home/runner/work/Rt-without-renewal/Rt-without-renewalJob Properties
ResultsA ratio greater than
Benchmark Group ListHere's a list of all the benchmark groups executed by this job:
Julia versioninfoTargetBaselineTarget resultBenchmark Report for /home/runner/work/Rt-without-renewal/Rt-without-renewalJob Properties
ResultsBelow is a table of this job's results, obtained by running the benchmarks.
Benchmark Group ListHere's a list of all the benchmark groups executed by this job:
Julia versioninfoBaseline resultBenchmark Report for /home/runner/work/Rt-without-renewal/Rt-without-renewalJob Properties
ResultsBelow is a table of this job's results, obtained by running the benchmarks.
Benchmark Group ListHere's a list of all the benchmark groups executed by this job:
Julia versioninfoRuntime information
|
seabbs
reviewed
Jul 24, 2024
seabbs
reviewed
Jul 24, 2024
seabbs
reviewed
Jul 24, 2024
seabbs
reviewed
Jul 24, 2024
seabbs
reviewed
Jul 24, 2024
seabbs
reviewed
Jul 24, 2024
|
Replying to a comment above:
I haven't done this... but an option is to stop using a development approach to The main downside is that a change to |
Benchmark resultJudge resultBenchmark Report for /home/runner/work/Rt-without-renewal/Rt-without-renewalJob Properties
ResultsA ratio greater than
Benchmark Group ListHere's a list of all the benchmark groups executed by this job:
Julia versioninfoTargetBaselineTarget resultBenchmark Report for /home/runner/work/Rt-without-renewal/Rt-without-renewalJob Properties
ResultsBelow is a table of this job's results, obtained by running the benchmarks.
Benchmark Group ListHere's a list of all the benchmark groups executed by this job:
Julia versioninfoBaseline resultBenchmark Report for /home/runner/work/Rt-without-renewal/Rt-without-renewalJob Properties
ResultsBelow is a table of this job's results, obtained by running the benchmarks.
Benchmark Group ListHere's a list of all the benchmark groups executed by this job:
Julia versioninfoRuntime information
|
I think we should think about this in a new issue. There are upsides and downsides as you note and I'm not clear what the best choice is or if we can mitigate the downsides of either approach in some way to make the answer clear |
seabbs
approved these changes
Jul 24, 2024
There was a problem hiding this comment.
This is looking really nice now. @kaitejohnson is you can have another go that would be amazing and report back on how you go.
IMO these things always benefit from a few rounds of user feedback to get a good pattern set up that most people can get the hang of quickly.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR expands the replication of Mishra 2022 in two ways:
RtWithoutRenewal.I think this addresses the problem of this replication notebook requiring far too much from a first time user (e.g. close familiarity with
Pluto, a desire to run the notebook locally in a way not described here) whilst not ditching the Pluto approach entirely. I've tried local build and running from the REPL... but I'm maybe not the best person to judge user friendliness.Very interested in views from @kaitejohnson.
Closes #319