https://github.com/python-pillow/pillow-perf
Pillow Performance Tests
https://github.com/python-pillow/pillow-perf
Last synced: 8 months ago
JSON representation
Pillow Performance Tests
- Host: GitHub
- URL: https://github.com/python-pillow/pillow-perf
- Owner: python-pillow
- License: mit
- Created: 2016-05-28T19:08:59.000Z (over 9 years ago)
- Default Branch: main
- Last Pushed: 2024-06-17T22:32:51.000Z (over 1 year ago)
- Last Synced: 2025-04-09T09:51:43.010Z (9 months ago)
- Language: Python
- Homepage: https://python-pillow.org/pillow-perf/
- Size: 34.7 MB
- Stars: 18
- Watchers: 4
- Forks: 8
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Test Suites
[](https://github.com/python-pillow/pillow-perf/actions)
Performance tests divided into suites.
### Prerequisites
* [Any Pillow version](https://pillow.readthedocs.io/en/latest/installation.html#basic-installation)
* [ImageMagick dev package for Wand](http://docs.wand-py.org/en/0.4.4/#requirements)
* OpenCV for Python, for example through
[opencv-python](https://pypi.org/project/opencv-python/) binary package
### Install and run
```bash
$ cd testsuite
$ pip install -r ./requirements.txt
$ ./run.py test_suite [test_suite ...]
```
`test_suite` is one of available test suites:
```
load, convert, composition, rotate_right, scale,
blur, wand_load, wand_convert, wand_composition,
wand_rotate_right, wand_scale, wand_blur, cv2_load,
cv2_rotate_right, cv2_scale, cv2_blur
```
The list can grow, please refer to:
```bash
$ ./run.py --help
```
### CLI
```bash
$ ./run.py scale --progress
$ ./run.py scale --mode RGBA
$ ./run.py scale --runs 50
$ ./run.py scale --size 512x512
```
For some suites the chosen mode (`scale`, `blur`) does matter,
while others (`convert`, `composition`) work regardless of current mode.
# Automatic test
Automatic test launches test suites against relevant Pillow versions
including SSE4 and AVX2.
Currently it only works on Linux Ubuntu.
You have two ways to run the test:
Vagrant or host (tested on Ubuntu 14.04 and 16.04).
### Run in Vagrant
Please, ensure that you are using Vagrant version 1.8.7 or later.
```bash
$ cd auto
$ vagrant up
```
It will automatically start a full test
which can take over 10 minutes.
Run the test again:
```bash
$ vagrant provision --provision-with run
```
### Run on the host
First you need to install the prerequisites:
```bash
$ cd auto
$ sudo ./install_ubuntu.sh
```
Script options:
```bash
$ cd auto
$ ./run.sh # Run all tests
$ ./run.sh no # Skip AVX2 tests
$ ./run.sh - --json # Pass extra arguments to test suite
$ ./run.sh no --json # Pass extra arguments and skip AVX2 tests
$ CC="ccache cc" ./run.sh # Speed up subsequent builds using CC cache
```
### Submit results
1. Before running any tests, please ensure that
you have exited all browsers on the host machine,
closed all audio players and stopped any backup systems.
The full test lasts up to 15 minutes.
2. Run [automatic test](#automatic-test) with `--json` option.
Please avoid custom `--size`, `--mode` and `--runs` settings.
```bash
$ ./run.sh - --json
```
3. Collect the following information about your system:
name, OS version, CPU. For example:
* Name: MacBook Pro (Retina, 13-inch, Late 2013)
* OS: Ubuntu 14.04.4 LTS 64bit
* CPU: Intel® Core™ i5-4258U CPU @ 2.40GHz
4. Create an [issue](https://github.com/python-pillow/pillow-perf/issues)
with the collected information and test output.
# Docs
The docs can be found on the [public page](https://python-pillow.org/pillow-perf/)
with benchmark results and details.
### Build once
```bash
$ cd docs
$ npm install
$ npm run build
```
### Serve locally & rebuild
```bash
$ python3 -m http.server &
$ npm run watch
```
`--watch-poll` will help if you have any problems with auto reload.