From 9df6e7072450b0e5acda0e60089f6537aa79e7a9 Mon Sep 17 00:00:00 2001 From: GitHub Actions Date: Fri, 20 Sep 2024 15:30:11 +0000 Subject: [PATCH] site deploy Auto-generated via {sandpaper} Source : f6b6a3862348fe0793228e44eb4c2ed6b4f72f86 Branch : md-outputs Author : GitHub Actions Time : 2024-09-20 15:29:50 +0000 Message : markdown source builds Auto-generated via {sandpaper} Source : c077de0a426944b59d2b56e61734151c14f4d799 Branch : main Author : Robert Chisholm Time : 2024-09-20 15:27:15 +0000 Message : Reference had been removed from config.yaml This meant the glossary was not being built. --- 404.html | 6 +- CODE_OF_CONDUCT.html | 6 +- LICENSE.html | 6 +- acknowledgements.html | 6 +- aio.html | 6 +- config.yaml | 1 + images.html | 6 +- index.html | 8 +- instructor-notes.html | 6 +- instructor/404.html | 6 +- instructor/CODE_OF_CONDUCT.html | 6 +- instructor/LICENSE.html | 6 +- instructor/acknowledgements.html | 6 +- instructor/aio.html | 8 +- instructor/images.html | 6 +- instructor/index.html | 8 +- instructor/instructor-notes.html | 6 +- instructor/key-points.html | 6 +- instructor/long-break1.html | 6 +- instructor/optimisation-conclusion.html | 6 +- ...timisation-data-structures-algorithms.html | 6 +- instructor/optimisation-introduction.html | 8 +- instructor/optimisation-memory.html | 6 +- instructor/optimisation-minimise-python.html | 6 +- instructor/optimisation-use-latest.html | 6 +- instructor/ppp.html | 6 +- instructor/profiles.html | 8 +- instructor/profiling-conclusion.html | 6 +- instructor/profiling-functions.html | 6 +- instructor/profiling-introduction.html | 6 +- instructor/profiling-lines.html | 6 +- instructor/reference.html | 573 ++++++++++++++++++ instructor/registration.html | 6 +- instructor/short-break1.html | 6 +- key-points.html | 6 +- long-break1.html | 6 +- md5sum.txt | 3 +- optimisation-conclusion.html | 6 +- optimisation-data-structures-algorithms.html | 6 +- optimisation-introduction.html | 6 +- optimisation-memory.html | 6 +- optimisation-minimise-python.html | 6 +- optimisation-use-latest.html | 6 +- pkgdown.yml | 2 +- ppp.html | 6 +- profiles.html | 8 +- profiling-conclusion.html | 6 +- profiling-functions.html | 6 +- profiling-introduction.html | 6 +- profiling-lines.html | 6 +- reference.html | 571 +++++++++++++++++ registration.html | 6 +- short-break1.html | 6 +- sitemap.xml | 6 + 54 files changed, 1314 insertions(+), 142 deletions(-) create mode 100644 instructor/reference.html create mode 100644 reference.html diff --git a/404.html b/404.html index 037c4d4..58eab91 100644 --- a/404.html +++ b/404.html @@ -105,6 +105,7 @@ Performance Profiling & Optimisation (Python): Reference +
+ Performance Profiling & Optimisation (Python) +
+ +
+
+ + + + + +
+
+

Reference

+

Last updated on 2024-09-20 | + + Edit this page

+ + + + + +
+ +
+ + +

Glossary

+
Array
+
+A data-structure that stores a collection of elements, typically of the +same type, arranged in contiguous memory locations. Arrays enable +elements to be iterated in order or directly accessed according to their +index. Arrays do not support appending or removing items, Python’s lists +wrap an array to provide support for greater flexibility such as +appending. +
+
Benchmarking
+
+The process of running a program in order to assess it’s overall +performance. This can be useful to confirm the impact of optimisations. +
+
Bottleneck
+
+The component with the lowest throughput, which limits performance of +the overall program. Improving the throughput of this component should +improve the overall performance. +
+

Bottleneck is a synonym of limiting factor.

+
Call Stack
+
+The internal stack data-structure used during the execution of code, +that tracks metadata related to the currently executing hierarchy of +function calls. Elements in the call stack are referred to as stack +frames. +
+
cProfile
+
+A function level profiler provided by the Python standard library. +
+
Hot Path
+
+The parts of the code that are executed very frequently during normal +operation. +
+
Latency
+
+The time taken for an operation to complete. +
+
Limiting Factor
+
+The component with the lowest throughput, which limits performance of +the overall program. Improving the throughput of this component should +improve the overall performance. +
+

Limiting factor is a synonym of bottleneck.

+
line_profiler
+
+A line level profiler for Python that can be installed via +pip. +
+
Pop
+
+The action of removing the top item from a stack data-structure +(sometimes also used in reference to removing and returning the first +item from a list or queue). +
+
Profiling
+
+The measuring and analysis of granular performance metrics of a program, +to understand where time is being spent during execution. Typically used +to prioritise optimisation. +
+
Push
+
+The action of adding an item to the top of a stack data-structure +(sometimes also used in reference to appending an item to a list or +queue). +
+
Recursive
+
+A recursive function or algorithm is one that calls itself. Too many +recursive calls, can lead to stack overflow exceptions. Most recursive +functions can be restructured as loops. +
+
snakeviz
+
+A web-browser based visualisation tool for cProfile outputs +that can be installed via pip. +
+
Stack
+
+A last-in-first-out (LIFO) data structure. Similar in nature to a +physical stack (e.g. of books), items are added to the top and those +below the top cannot be accessed without first removing the ones above +them. +
+
Stack Frame
+
+The term used to refer to elements within the call stack. A call stack’s +stack frame will contain metadata about a particular function call, such +as where it was called from and any variables that have been allocated +‘on the stack’ within the function’s local scope. When a stack frame is +popped from the call stack, any variables allocated within the +corresponding function’s local scope would be deallocated. +
+
viztracer
+
+A timeline profiler for Python that can be installed via +pip. +
+
+
+ + +
+
+ + + diff --git a/instructor/registration.html b/instructor/registration.html index ac3bdf2..c7e7bf4 100644 --- a/instructor/registration.html +++ b/instructor/registration.html @@ -102,7 +102,7 @@ - Performance Profiling & Optimisation (Python): Reference +
+ Performance Profiling & Optimisation (Python) +
+ +
+
+ + + + + +
+
+

Reference

+

Last updated on 2024-09-20 | + + Edit this page

+ + + +
+ +
+ + +

Glossary

+
Array
+
+A data-structure that stores a collection of elements, typically of the +same type, arranged in contiguous memory locations. Arrays enable +elements to be iterated in order or directly accessed according to their +index. Arrays do not support appending or removing items, Python’s lists +wrap an array to provide support for greater flexibility such as +appending. +
+
Benchmarking
+
+The process of running a program in order to assess it’s overall +performance. This can be useful to confirm the impact of optimisations. +
+
Bottleneck
+
+The component with the lowest throughput, which limits performance of +the overall program. Improving the throughput of this component should +improve the overall performance. +
+

Bottleneck is a synonym of limiting factor.

+
Call Stack
+
+The internal stack data-structure used during the execution of code, +that tracks metadata related to the currently executing hierarchy of +function calls. Elements in the call stack are referred to as stack +frames. +
+
cProfile
+
+A function level profiler provided by the Python standard library. +
+
Hot Path
+
+The parts of the code that are executed very frequently during normal +operation. +
+
Latency
+
+The time taken for an operation to complete. +
+
Limiting Factor
+
+The component with the lowest throughput, which limits performance of +the overall program. Improving the throughput of this component should +improve the overall performance. +
+

Limiting factor is a synonym of bottleneck.

+
line_profiler
+
+A line level profiler for Python that can be installed via +pip. +
+
Pop
+
+The action of removing the top item from a stack data-structure +(sometimes also used in reference to removing and returning the first +item from a list or queue). +
+
Profiling
+
+The measuring and analysis of granular performance metrics of a program, +to understand where time is being spent during execution. Typically used +to prioritise optimisation. +
+
Push
+
+The action of adding an item to the top of a stack data-structure +(sometimes also used in reference to appending an item to a list or +queue). +
+
Recursive
+
+A recursive function or algorithm is one that calls itself. Too many +recursive calls, can lead to stack overflow exceptions. Most recursive +functions can be restructured as loops. +
+
snakeviz
+
+A web-browser based visualisation tool for cProfile outputs +that can be installed via pip. +
+
Stack
+
+A last-in-first-out (LIFO) data structure. Similar in nature to a +physical stack (e.g. of books), items are added to the top and those +below the top cannot be accessed without first removing the ones above +them. +
+
Stack Frame
+
+The term used to refer to elements within the call stack. A call stack’s +stack frame will contain metadata about a particular function call, such +as where it was called from and any variables that have been allocated +‘on the stack’ within the function’s local scope. When a stack frame is +popped from the call stack, any variables allocated within the +corresponding function’s local scope would be deallocated. +
+
viztracer
+
+A timeline profiler for Python that can be installed via +pip. +
+
+
+ + +
+
+ + + diff --git a/registration.html b/registration.html index 56b63dc..b14428a 100644 --- a/registration.html +++ b/registration.html @@ -102,7 +102,7 @@ -