Skip to content

Commit

Permalink
prettier fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
@sfmig
sfmig committed Jan 23, 2024
1 parent 22350c0 commit 61d2aa9
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 18 deletions.
25 changes: 12 additions & 13 deletions docs/pages/benchmarking.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,17 @@ layout: default

# Benchmarking

| Name | Short description | 🚦 | Used by |
| ------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | :-----: |
| [asv](https://asv.readthedocs.io/en/stable/) | A tool for benchmarking Python packages over their lifetime. Allows you to write benchmarks and then run them against every commit in the repository, to identify where performance increased or decreased. Comparative benchmarks can also be run, which may be useful for [running them in CI using GitHub runners](https://labs.quansight.org/blog/2021/08/github-actions-benchmarks). Used by [numpy](https://github.com/numpy/numpy/tree/main/benchmarks), [scikit-image](https://github.com/scikit-image/scikit-image/tree/main/benchmarks), [napari](https://github.com/napari/napari/tree/main/napari/benchmarks) and [astropy](https://github.com/astropy/astropy-benchmarks). | 🟢 | |


| Name | Short description | 🚦 | Used by |
| -------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | :-----: |
| [asv](https://asv.readthedocs.io/en/stable/) | A tool for benchmarking Python packages over their lifetime. Allows you to write benchmarks and then run them against every commit in the repository, to identify where performance increased or decreased. Comparative benchmarks can also be run, which may be useful for [running them in CI using GitHub runners](https://labs.quansight.org/blog/2021/08/github-actions-benchmarks). Used by [numpy](https://github.com/numpy/numpy/tree/main/benchmarks), [scikit-image](https://github.com/scikit-image/scikit-image/tree/main/benchmarks), [napari](https://github.com/napari/napari/tree/main/napari/benchmarks) and [astropy](https://github.com/astropy/astropy-benchmarks). | 🟢 | |

# Profiling
| Name | Short description | 🚦 | Used by |
| ------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | :-----: |
| [psutil](https://psutil.readthedocs.io/en/latest/) | System monitoring, profiling, limiting process resources and the management of running processes. | 🟢 | [Puppet Submitty](https://github.com/UCL-ARC/puppet-submitty), [Quality Workflow tool](https://github.com/UCL-ARC/qw) |
| [pyinstrument](https://pyinstrument.readthedocs.io/en/stable) | Python profiler. Tells you how long individual lines of code take to run, so you can focus on the slowest part of your program to speed it up. | 🟢 | |
| [snakeviz](https://jiffyclub.github.io/snakeviz/) | Browser based graphical viewer for the output of Python’s cProfile module. | 🟢 |
| [memray](https://bloomberg.github.io/memray/) | Memray tracks and reports memory allocations, both in Python code and in compiled extension modules. It also has a [plugin](https://pytest-memray.readthedocs.io/en/latest/) for easy integration with pytest. However, it only works on Linux and MacOS, and cannot be installed on other platforms. | 🟠 | |
| [line_profiler](https://pypi.org/project/line-profiler/) | It is a module for doing line-by-line profiling of functions. | 🟠 | |
| [memory_profiler](https://pypi.org/project/memory-profiler/) | This package is no longer actively maintained. It is a python module for monitoring memory consumption of a process as well as line-by-line analysis of memory consumption. | 🔴 | |

| Name | Short description | 🚦 | Used by |
| ------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- | :-------------------------------------------------------------------------------------------------------------------: |
| [psutil](https://psutil.readthedocs.io/en/latest/) | System monitoring, profiling, limiting process resources and the management of running processes. | 🟢 | [Puppet Submitty](https://github.com/UCL-ARC/puppet-submitty), [Quality Workflow tool](https://github.com/UCL-ARC/qw) |
| [pyinstrument](https://pyinstrument.readthedocs.io/en/stable) | Python profiler. Tells you how long individual lines of code take to run, so you can focus on the slowest part of your program to speed it up. | 🟢 | |
| [snakeviz](https://jiffyclub.github.io/snakeviz/) | Browser based graphical viewer for the output of Python’s cProfile module. | 🟢 |
| [memray](https://bloomberg.github.io/memray/) | Memray tracks and reports memory allocations, both in Python code and in compiled extension modules. It also has a [plugin](https://pytest-memray.readthedocs.io/en/latest/) for easy integration with pytest. However, it only works on Linux and MacOS, and cannot be installed on other platforms. | 🟠 | |
| [line_profiler](https://pypi.org/project/line-profiler/) | It is a module for doing line-by-line profiling of functions. | 🟠 | |
| [memory_profiler](https://pypi.org/project/memory-profiler/) | This package is no longer actively maintained. It is a python module for monitoring memory consumption of a process as well as line-by-line analysis of memory consumption. | 🔴 | |
10 changes: 5 additions & 5 deletions docs/pages/dev.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,8 @@ layout: default

# Other

| Name | Short description | 🚦 | Used by |
| ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------- | --- | :-------------------------------------------------------------------------------------------------------------------: |
| [jedi](https://jedi.readthedocs.io/en/latest/) | Refactoring and autocompletion used in IDEs. | 🟢 | |
| [rope](https://rope.readthedocs.io/en/latest/overview.html) | Refactoring library. | | |
| [tqdm](https://pypi.org/project/tqdm/2.2.3/) | Progress bar for loops. | 🟢 | [RRED](https://github.com/UCL-ARC/rred-reports) |
| Name | Short description | 🚦 | Used by |
| ----------------------------------------------------------- | -------------------------------------------- | --- | :---------------------------------------------: |
| [jedi](https://jedi.readthedocs.io/en/latest/) | Refactoring and autocompletion used in IDEs. | 🟢 | |
| [rope](https://rope.readthedocs.io/en/latest/overview.html) | Refactoring library. | | |
| [tqdm](https://pypi.org/project/tqdm/2.2.3/) | Progress bar for loops. | 🟢 | [RRED](https://github.com/UCL-ARC/rred-reports) |

0 comments on commit 61d2aa9

Please sign in to comment.