benwtrent commented on code in PR #12663: URL: https://github.com/apache/lucene/pull/12663#discussion_r1356970803
########## lucene/benchmark-jmh/README.txt: ########## @@ -0,0 +1,21 @@ +The :lucene:benchmark-jmh module contains can be used to compile +and execute JMH (https://github.com/openjdk/jmh) micro-benchmarks. + +Look at existing classes and JMH documentation for inspiration on how +to write good micro-benchmarks. + +To compile the project and prepare JMH launcher, run: + +gradlew :lucene:benchmark-jmh:assemble + +The above target will display exact commands to execute JMH from +command line, for example: + +java --module-path lucene\benchmark-jmh\build\benchmarks --module org.apache.lucene.benchmark.jmh + +You can pass any JMH options to the above command, for example: + + -h displays verbose help for all options + -l list available benchmarks + -lp list benchmarks that pass the filter and their parameters + regexp execute all benchmark containing regexp Review Comment: ```suggestion regexp execute all benchmark containing regexp Here is an example running a single benchmark: java --module-path lucene\benchmark-jmh\build\benchmarks --module org.apache.lucene.benchmark.jmh org.apache.lucene.benchmark.jmh.BinaryCosineBenchmark.cosineDistanceNew Or running all of BinaryCosineBenchmark java --module-path lucene\benchmark-jmh\build\benchmarks --module org.apache.lucene.benchmark.jmh org.apache.lucene.benchmark.jmh.BinaryCosineBenchmark ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@lucene.apache.org For additional commands, e-mail: issues-h...@lucene.apache.org
