Updated documentation and project description.

Signed-off-by: dblock <[email protected]>
opensearch-project · Oct 13, 2023 · d65095d · d65095d
1 parent e2ccdd0
commit d65095d
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -26,7 +26,7 @@ For more information, see [opensearch.org](https://opensearch.org/) and the [API
 
 ## User Guide
 
-To get started with the OpenSearch Python Client, see [User Guide](https://github.com/opensearch-project/opensearch-py/blob/main/USER_GUIDE.md). This repository also contains [working samples](samples) and [benchmarks](benchmarks).
+To get started with the OpenSearch Python Client, see [User Guide](https://github.com/opensearch-project/opensearch-py/blob/main/USER_GUIDE.md). This repository also contains [working samples](https://github.com/opensearch-project/opensearch-py/tree/main/samples) and [benchmarks](https://github.com/opensearch-project/opensearch-py/tree/main/benchmarks).
 
 ## Compatibility with OpenSearch
 

diff --git a/benchmarks/README.md b/benchmarks/README.md
@@ -28,8 +28,12 @@ Benchmarks use the code in this repository by specifying the dependency as `open
 Run all benchmarks available as follows.
 
 ```
-$ poetry run richbench . --repeat 1 --times 1
+poetry run richbench . --repeat 1 --times 1
+```
+
+Outputs results from all the runs.
 
+```
                                              Benchmarks, repeat=1, number=1                                              
 ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┓
 ┃                         Benchmark ┃ Min     ┃ Max     ┃ Mean    ┃ Min (+)         ┃ Max (+)         ┃ Mean (+)        ┃
@@ -44,8 +48,12 @@ $ poetry run richbench . --repeat 1 --times 1
 Run a specific benchmark, e.g. [bench_sync.py](bench_sync.py) by specifying `--benchmark [name]`.
 
 ```
-$ poetry run richbench . --repeat 1 --times 1 --benchmark sync
+poetry run richbench . --repeat 1 --times 1 --benchmark sync
+```
+
+Outputs results from one benchmark.
 
+```
                                             Benchmarks, repeat=1, number=1                                            
 ┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━┓
 ┃                      Benchmark ┃ Min     ┃ Max     ┃ Mean    ┃ Min (+)         ┃ Max (+)         ┃ Mean (+)        ┃

diff --git a/benchmarks/pyproject.toml b/benchmarks/pyproject.toml
@@ -1,7 +1,7 @@
 [tool.poetry]
 name = "package"
 version = "0.1.0"
-description = "OpenSearch samples."
+description = "OpenSearch Python client benchmarks."
 authors = ["Daniel Doubrovkine <[email protected]>"]
 license = "Apache 2.0"
 readme = "README.md"