aboutsummaryrefslogtreecommitdiff
path: root/benchmarks/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'benchmarks/README.md')
-rw-r--r--benchmarks/README.md41
1 files changed, 21 insertions, 20 deletions
diff --git a/benchmarks/README.md b/benchmarks/README.md
index 71104d69..459c7b9d 100644
--- a/benchmarks/README.md
+++ b/benchmarks/README.md
@@ -7,45 +7,46 @@ protobuf language runtime.
## Prerequisite
-First, you need to follow the instruction in the root directory's README to
+First, you need to follow the instruction in the root directory's README to
build your language's protobuf, then:
### CPP
You need to install [cmake](https://cmake.org/) before building the benchmark.
-We are using [google/benchmark](https://github.com/google/benchmark) as the
-benchmark tool for testing cpp. This will be automaticly made during build the
+We are using [google/benchmark](https://github.com/google/benchmark) as the
+benchmark tool for testing cpp. This will be automaticly made during build the
cpp benchmark.
### Java
-We're using maven to build the java benchmarks, which is the same as to build
-the Java protobuf. There're no other tools need to install. We're using
-[google/caliper](https://github.com/google/caliper) as benchmark tool, which
+We're using maven to build the java benchmarks, which is the same as to build
+the Java protobuf. There're no other tools need to install. We're using
+[google/caliper](https://github.com/google/caliper) as benchmark tool, which
can be automaticly included by maven.
### Python
-We're using python C++ API for testing the generated
+We're using python C++ API for testing the generated
CPP proto version of python protobuf, which is also a prerequisite for Python
-protobuf cpp implementation. You need to install the correct version of Python
-C++ extension package before run generated CPP proto version of Python
-protobuf's benchmark. e.g. under Ubuntu, you need to
+protobuf cpp implementation. You need to install the correct version of Python
+C++ extension package before run generated CPP proto version of Python
+protobuf's benchmark. e.g. under Ubuntu, you need to
```
-$ sudo apt-get install python-dev
+$ sudo apt-get install python-dev
$ sudo apt-get install python3-dev
```
-And you also need to make sure `pkg-config` is installed.
+And you also need to make sure `pkg-config` is installed.
### Big data
-There's some optional big testing data which is not included in the directory initially, you need to
-run the following command to download the testing data:
+There's some optional big testing data which is not included in the directory
+initially, you need to run the following command to download the testing data:
```
-$ ./download_data.sh
+$ ./download_data.sh
```
-After doing this the big data file will automaticly generated in the benchmark directory.
+After doing this the big data file will automaticly generated in the
+benchmark directory.
## Run instructions
@@ -65,8 +66,8 @@ $ make cpp
### Python:
-We have three versions of python protobuf implementation: pure python, cpp reflection and
-cpp generated code. To run these version benchmark, you need to:
+We have three versions of python protobuf implementation: pure python, cpp
+reflection and cpp generated code. To run these version benchmark, you need to:
#### Pure Python:
@@ -84,8 +85,8 @@ $ make python-cpp-reflection
```
$ make python-cpp-generated-code
-```
-
+```
+
To run a specific dataset:
### Java: