First Review Changes - Part 1

[Robadob]

Changes to address before Feb 15th

• index.md
  • Replace/remove badge
• profiling_introduction.md
  • screenshot of a timeline from a profiler to annotate timeline profilers
  • GTA callout:
    • why the source code was not optimised at he first place?
    • How much development time the company saved ?
    • Why we have so much buggy software/early access release?
  • Trusting quality/correctness/perf of packages
• profiling-functions.md
  • explain call-stack to give context to function level profiling.
  • • traceback https://docs.python.org/3/library/traceback.html
  • Change download links to download attributed anchors
  • Improve cprofile re.compile() example with something more accessible.
  • The pred-prey exercise solution could be more verbose/include screenshots?
• profiling-lines.md
  • Change download links to download attributed anchors
• opt-intro
  • Could an applied example/exercise be created to hammer home premature optimisation? Code that goes faster but makes no sense. (This could be examples away from software development, e.g. structuring a startup so that it can scale to millions of customers before it has even one.
  • PyTest explanation needs to be longer
  • Simple pytest exercise? e.g. cover edge-cases
  • Review overview of what's to be covered after restructure
  • Can we explain CPython/C/Python bytecode here? It gets mentioned in the following episode with no context.
• data-structures.md
  • Feels very long now, generator functions feels weak could be removed? (also remove from intro/conclusion)
  • This section could wrap an exercise proposing some hypothetical situations, what's the appropriate data structure/algorithm?
• minimise-python.md
  • functional operators section may be wrong, it appears reduce() is implemented in pure python
    • https://github.com/python/cpython/blob/424df31f00e2106eab6b8e747fc4695b00787fe5/Lib/functools.py#L237
  • Is there a more wordy way to explain "filter early"
• uptodate.md
  • is there a recommended way to update/find latest supported python version/packages?
• big break
• memory.md
  • This is technical, needs to have more diagrams etc to ease the learning
  • Need to introduce terms like L1, CPU
  • Diagrams would help
    • Annotated photo of a motherboard (cpu/ram/harddrives/gpu?)
    • NV architecture style graphic to visualise CPU/L1/L2/L3 cache + ram
    • disk access one?
  • Now that numpy comes first, may be able to build a working example for variable access
• opt-conclusion.md
  • complete keypoints
  • Refer to further reading
• Add an acknowledgements/contributors page.
• Add explicit breaks (this is a carpentries standard thing)

[github-actions]

Thank you!

Thank you for your pull request 😃

🤖 This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}.

If you have files that automatically render output (e.g. R Markdown), then you should check for the following:

• 🎯 correct output
• 🖼️ correct figures
• ❓ new warnings
• ‼️ new errors

Rendered Changes

🔍 Inspect the changes: https://github.com/RSE-Sheffield/pando-python/compare/md-outputs..md-outputs-PR-13

The following changes were observed in the rendered markdown documents:

 acknowledgements.md (new)                          |   20 +
 config.yaml                                        |    6 +-
 fig/annotated-motherboard.jpg (new)                |  Bin 0 -> 417226 bytes
 fig/hardware.ai (new)                              | 1540 ++++++++++++++++++++
 fig/hardware.png (new)                             |  Bin 0 -> 25651 bytes
 fig/predprey_out.png (new)                         |  Bin 0 -> 73438 bytes
 fig/snakeviz-predprey-table.png (new)              |  Bin 0 -> 37033 bytes
 fig/testsuite-dir.png (new)                        |  Bin 0 -> 19915 bytes
 fig/viztracer-example.png (new)                    |  Bin 0 -> 119310 bytes
 md5sum.txt                                         |   20 +-
 ...d => optimisation-data-structures-algorithms.md |  198 ++-
 optimisation-introduction.md                       |  120 +-
 optimisation-list-tuple.md (gone)                  |  202 ---
 optimisation-memory.md                             |   36 +-
 optimisation-minimise-python.md                    |   30 +-
 optimisation-use-latest.md                         |   63 +-
 profiling-functions.md                             |  119 +-
 profiling-introduction.md                          |   22 +-
 profiling-lines.md                                 |   34 +-
 19 files changed, 2038 insertions(+), 372 deletions(-)

What does this mean?

If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible.

This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation.

⏱️ Updated at 2024-02-08 10:25:43 +0000