@@ -39,14 +39,13 @@ use of pip and git in the way above.
3939## Requirements
4040
4141The most central requirement to ** pybm** is ` git ` , a version control system,
42- which is responsible for building the benchmark environments correctly.
43- Currently, at least ` git version 2.17.0 ` (April 2018) is required for pybm to
44- work correctly. To check your git version, you can run ` git --version ` , which
45- should result in an output showing the version number, similar to the one seen
46- above.
42+ which is responsible for building benchmark environments.
43+ Currently, at least ` git version 2.23.0 ` (August 2019) is required for pybm to
44+ work correctly. To check your git version, run ` git --version ` , which
45+ should result in an output showing the version number, similar to the one above.
4746
4847On the Python side, in its most standard configuration, ** pybm** works almost
49- entirely within the Python standard library - only the ` yaml ` package is
48+ entirely within the Python standard library - only the ` pyyaml ` package is
5049required for configuration management. Additional functionality is available via
5150extras installation:
5251
@@ -55,8 +54,8 @@ extras installation:
5554python -m pip install git+https://github.com/nicholasjng/pybm[gbm]
5655```
5756
58- More functionality is planned for following releases of this project. Expect a
59- tentative roadmap to arrive soon .
57+ More features are planned for following releases of this project. For current
58+ feature requests and implementation status, check the Issues tab and milestones .
6059
6160## Documentation and examples
6261
@@ -71,14 +70,13 @@ has already been put to the test, you can expect some sharp edges when using it
7170for your own benchmarking purposes.
7271
7372Functionality has so far been tested on Darwin ARM64 and macOS 11 (my
74- development machine). While great care was exercised to exclusively use
75- cross-platform Python APIs and thus make pybm as portable as possible, flawless
76- execution on other platforms cannot be guaranteed at this time.
73+ development machine), and Ubuntu through GitHub Actions. While great care was
74+ exercised to exclusively use cross-platform Python APIs and thus make pybm as
75+ portable as possible, flawless execution on other platforms cannot be
76+ guaranteed.
7777
78- Computers running Linux should be able to use pybm as well, barring some
79- unforeseen platform implementation differences from macOS ARM. Only Windows will
80- most likely not work out of the box (due to different command line calling
81- conventions and executable names).
78+ Windows will most likely not work out of the box (due to different command line
79+ calling conventions and executable names).
8280
8381## Contributing to pybm
8482
@@ -95,4 +93,4 @@ GitHub profile.
9593
9694The idea for this project came in June 2021, during some hobby work on the JAX
9795project. Especially the custom Python requirements machinery became necessary
98- due to the different platforms and package requirements posed by JAX.
96+ due to the different platforms and package requirements posed by JAX.
0 commit comments