X-Git-Url: https://git.mdrn.pl/pylucene.git/blobdiff_plain/a2e61f0c04805cfcb8706176758d1283c7e3a55c..aaeed5504b982cf3545252ab528713250aa33eed:/lucene-java-3.5.0/lucene/contrib/benchmark/src/java/org/apache/lucene/benchmark/package.html?ds=sidebyside
diff --git a/lucene-java-3.5.0/lucene/contrib/benchmark/src/java/org/apache/lucene/benchmark/package.html b/lucene-java-3.5.0/lucene/contrib/benchmark/src/java/org/apache/lucene/benchmark/package.html
new file mode 100644
index 0000000..dc28bc8
--- /dev/null
+++ b/lucene-java-3.5.0/lucene/contrib/benchmark/src/java/org/apache/lucene/benchmark/package.html
@@ -0,0 +1,45 @@
+
+
+
+
+
+
+ The benchmark contribution contains tools for benchmarking Lucene using standard, freely available corpora. ANT will
+ download the corpus automatically, place it in a temp directory and then unpack it to the working.dir directory specified in the build.
+ The temp directory
+ and working directory can be safely removed after a run. However, the next time the task is run, it will need to download the files again.
+
+ Classes implementing the Benchmarker interface should have a no-argument constructor if they are to be used with the Driver class. The Driver
+ class is provided for convenience only. Feel free to implement your own main class for your benchmarker.
+
+ The StandardBenchmarker is meant to be just that, a standard that runs out of the box with no configuration or changes needed.
+ Other benchmarking classes may derive from it to provide alternate views or to take in command line options. When reporting benchmarking runs
+ you should state any alterations you have made.
+
+ To run the short version of the StandardBenchmarker, call "ant run-micro-standard". This should take a minute or so to complete and give you a preliminary idea of how your change affects the code
+
+ To run the long version of the StandardBenchmarker, call "ant run-standard". This takes considerably longer.
+
+ The original code for these classes was donated by Andrzej Bialecki at http://issues.apache.org/jira/browse/LUCENE-675 and has been updated by Grant Ingersoll to make some parts of the code reusable in other benchmarkers
+
+