You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@lucene.apache.org by GitBox <gi...@apache.org> on 2022/04/28 22:02:42 UTC
[GitHub] [lucene] gautamworah96 opened a new pull request, #853: LUCENE-10524 Add benchmark suite details to CONTRIBUTING.md
gautamworah96 opened a new pull request, #853:
URL: https://github.com/apache/lucene/pull/853
Today, new contributors are usually unaware of where luceneutil benchmarks are and when/how to run them. Committers usually end up pointing contributors to the benchmarks package when they make perf impacting changes and then they run the benchmarks.
Adding benchmark details to the Lucene repo will also make them more accessible to other researchers who want to experiment/benchmark their own custom task implementation with Java Lucene.
JIRA: https://issues.apache.org/jira/browse/LUCENE-10524
cc: @mocobeta
--
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-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene] mikemccand commented on a diff in pull request #853: LUCENE-10524 Add benchmark suite details to CONTRIBUTING.md
Posted by GitBox <gi...@apache.org>.
mikemccand commented on code in PR #853:
URL: https://github.com/apache/lucene/pull/853#discussion_r861733565
##########
CONTRIBUTING.md:
##########
@@ -66,6 +66,16 @@ In case your contribution fixes a bug, please create a new test case that fails
- *Eclipse* - Basic support ([help/IDEs.txt](https://github.com/apache/lucene/blob/main/help/IDEs.txt#L7)).
- *Netbeans* - Not tested.
+## Benchmarking
+
+Use the tool suite at [luceneutil](https://github.com/mikemccand/luceneutil) to benchmark your code changes
+if you think that your change may have measurably changed the performance of a task.
Review Comment:
Maybe add "These are the same benchmarks that run in [nightly benchmarks](https://home.apache.org/~mikemccand/lucenebench/)" or so?
##########
CONTRIBUTING.md:
##########
@@ -66,6 +66,16 @@ In case your contribution fixes a bug, please create a new test case that fails
- *Eclipse* - Basic support ([help/IDEs.txt](https://github.com/apache/lucene/blob/main/help/IDEs.txt#L7)).
- *Netbeans* - Not tested.
+## Benchmarking
+
+Use the tool suite at [luceneutil](https://github.com/mikemccand/luceneutil) to benchmark your code changes
+if you think that your change may have measurably changed the performance of a task.
+
+The instructions for running the benchmarks can be found in the luceneutil [README](https://github.com/mikemccand/luceneutil/blob/master/README.md).
+
+The Lucene community is also interested in other implementations of these benchmark tasks.
+Feel free to share your findings (especially if your implementation performs better!) through the [Lucene mailing lists](https://lucene.apache.org/core/discussion.html).
Review Comment:
Maybe also suggest "...or open an issue or pr in the luceneutil project"?
--
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-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene] gautamworah96 commented on a diff in pull request #853: LUCENE-10524 Add benchmark suite details to CONTRIBUTING.md
Posted by GitBox <gi...@apache.org>.
gautamworah96 commented on code in PR #853:
URL: https://github.com/apache/lucene/pull/853#discussion_r863079957
##########
CONTRIBUTING.md:
##########
@@ -66,6 +66,16 @@ In case your contribution fixes a bug, please create a new test case that fails
- *Eclipse* - Basic support ([help/IDEs.txt](https://github.com/apache/lucene/blob/main/help/IDEs.txt#L7)).
- *Netbeans* - Not tested.
+## Benchmarking
+
+Use the tool suite at [luceneutil](https://github.com/mikemccand/luceneutil) to benchmark your code changes
+if you think that your change may have measurably changed the performance of a task.
+
+The instructions for running the benchmarks can be found in the luceneutil [README](https://github.com/mikemccand/luceneutil/blob/master/README.md).
+
+The Lucene community is also interested in other implementations of these benchmark tasks.
+Feel free to share your findings (especially if your implementation performs better!) through the [Lucene mailing lists](https://lucene.apache.org/core/discussion.html).
Review Comment:
Added
##########
CONTRIBUTING.md:
##########
@@ -66,6 +66,16 @@ In case your contribution fixes a bug, please create a new test case that fails
- *Eclipse* - Basic support ([help/IDEs.txt](https://github.com/apache/lucene/blob/main/help/IDEs.txt#L7)).
- *Netbeans* - Not tested.
+## Benchmarking
+
+Use the tool suite at [luceneutil](https://github.com/mikemccand/luceneutil) to benchmark your code changes
+if you think that your change may have measurably changed the performance of a task.
Review Comment:
Added
--
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-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene] mocobeta commented on pull request #853: LUCENE-10524 Add benchmark suite details to CONTRIBUTING.md
Posted by GitBox <gi...@apache.org>.
mocobeta commented on PR #853:
URL: https://github.com/apache/lucene/pull/853#issuecomment-1112798859
@gautamworah96 This looks good to me!
I wonder if it makes sense to mention the off-the-shelf https://github.com/apache/lucene/tree/main/lucene/benchmark module here too (I didn't find instruction for running it, but a mention still could be helpful).
I'd also suggest letting @mikemccand know the change, thanks.
--
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-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org
[GitHub] [lucene] mocobeta merged pull request #853: LUCENE-10524 Add benchmark suite details to CONTRIBUTING.md
Posted by GitBox <gi...@apache.org>.
mocobeta merged PR #853:
URL: https://github.com/apache/lucene/pull/853
--
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-unsubscribe@lucene.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscribe@lucene.apache.org
For additional commands, e-mail: issues-help@lucene.apache.org