Tweaked boilerplate: replicable -> reproducible (#1538)

castorini · May 1, 2021 · 24198e4 · 24198e4
1 parent f5876f9
commit 24198e4
Show file tree

Hide file tree

Showing 297 changed files with 814 additions and 446 deletions.
diff --git a/docs/experiments-jdiq2018.md b/docs/experiments-jdiq2018.md
@@ -23,7 +23,7 @@ Regression effectiveness values changed at commit [`e71df7a`](https://github.com
 **Update (6/12/2019)**:
 With commit [`75e36f9`](/~https://github.com/castorini/anserini/commit/75e36f97f7037d1ceb20fa9c91582eac5e974131), which upgrades Anserini to Lucene 8.0, we are no longer maintaining the reproducibility of these experiments.
 That is, running these commands will produce results different from the numbers reported here.
-The most recent version in which these results are reproducible is the [v0.5.1](/~https://github.com/castorini/anserini/releases) release (6/11/2019).
+The most recent version in which these results are reproduce is the [v0.5.1](/~https://github.com/castorini/anserini/releases) release (6/11/2019).
 
 ## Parameter Tuning
 

diff --git a/src/main/java/io/anserini/analysis/AnalyzerUtils.java b/src/main/java/io/anserini/analysis/AnalyzerUtils.java
@@ -1,5 +1,5 @@
 /*
- * Anserini: A Lucene toolkit for replicable information retrieval research
+ * Anserini: A Lucene toolkit for reproducible information retrieval research
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/io/anserini/analysis/DefaultEnglishAnalyzer.java b/src/main/java/io/anserini/analysis/DefaultEnglishAnalyzer.java
@@ -1,5 +1,5 @@
 /*
- * Anserini: A Lucene toolkit for replicable information retrieval research
+ * Anserini: A Lucene toolkit for reproducible information retrieval research
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -17,7 +17,6 @@
 package io.anserini.analysis;
 
 import org.apache.commons.io.FileUtils;
-import org.apache.lucene.analysis.Analyzer;
 import org.apache.lucene.analysis.CharArraySet;
 import org.apache.lucene.analysis.LowerCaseFilter;
 import org.apache.lucene.analysis.StopFilter;

diff --git a/src/main/java/io/anserini/analysis/TweetAnalyzer.java b/src/main/java/io/anserini/analysis/TweetAnalyzer.java
@@ -1,5 +1,5 @@
 /*
- * Anserini: A Lucene toolkit for replicable information retrieval research
+ * Anserini: A Lucene toolkit for reproducible information retrieval research
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/io/anserini/analysis/TweetLowerCaseEntityPreservingFilter.java b/src/main/java/io/anserini/analysis/TweetLowerCaseEntityPreservingFilter.java
@@ -1,5 +1,5 @@
 /*
- * Anserini: A Lucene toolkit for replicable information retrieval research
+ * Anserini: A Lucene toolkit for reproducible information retrieval research
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/io/anserini/analysis/TweetLowerCaseEntityPreservingFilterFactory.java b/src/main/java/io/anserini/analysis/TweetLowerCaseEntityPreservingFilterFactory.java
@@ -1,5 +1,5 @@
 /*
- * Anserini: A Lucene toolkit for replicable information retrieval research
+ * Anserini: A Lucene toolkit for reproducible information retrieval research
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/io/anserini/ann/ApproximateNearestNeighborEval.java b/src/main/java/io/anserini/ann/ApproximateNearestNeighborEval.java
@@ -1,5 +1,5 @@
 /*
- * Anserini: A Lucene toolkit for replicable information retrieval research
+ * Anserini: A Lucene toolkit for reproducible information retrieval research
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/io/anserini/ann/ApproximateNearestNeighborSearch.java b/src/main/java/io/anserini/ann/ApproximateNearestNeighborSearch.java
@@ -1,5 +1,5 @@
 /*
- * Anserini: A Lucene toolkit for replicable information retrieval research
+ * Anserini: A Lucene toolkit for reproducible information retrieval research
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/io/anserini/ann/FeatureVectorsTokenizer.java b/src/main/java/io/anserini/ann/FeatureVectorsTokenizer.java
@@ -1,5 +1,5 @@
 /*
- * Anserini: A Lucene toolkit for replicable information retrieval research
+ * Anserini: A Lucene toolkit for reproducible information retrieval research
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/io/anserini/ann/IndexVectors.java b/src/main/java/io/anserini/ann/IndexVectors.java
@@ -1,5 +1,5 @@
 /*
- * Anserini: A Lucene toolkit for replicable information retrieval research
+ * Anserini: A Lucene toolkit for reproducible information retrieval research
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/io/anserini/ann/fw/FakeWordsEncodeAndQuantizeFilter.java b/src/main/java/io/anserini/ann/fw/FakeWordsEncodeAndQuantizeFilter.java
@@ -1,5 +1,5 @@
 /*
- * Anserini: A Lucene toolkit for replicable information retrieval research
+ * Anserini: A Lucene toolkit for reproducible information retrieval research
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/io/anserini/ann/fw/FakeWordsEncoderAnalyzer.java b/src/main/java/io/anserini/ann/fw/FakeWordsEncoderAnalyzer.java
@@ -1,5 +1,5 @@
 /*
- * Anserini: A Lucene toolkit for replicable information retrieval research
+ * Anserini: A Lucene toolkit for reproducible information retrieval research
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/io/anserini/ann/lexlsh/LexicalLshAnalyzer.java b/src/main/java/io/anserini/ann/lexlsh/LexicalLshAnalyzer.java
@@ -1,5 +1,5 @@
 /*
- * Anserini: A Lucene toolkit for replicable information retrieval research
+ * Anserini: A Lucene toolkit for reproducible information retrieval research
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/io/anserini/ann/lexlsh/LexicalLshFeaturePositionTokenFilter.java b/src/main/java/io/anserini/ann/lexlsh/LexicalLshFeaturePositionTokenFilter.java
@@ -1,5 +1,5 @@
 /*
- * Anserini: A Lucene toolkit for replicable information retrieval research
+ * Anserini: A Lucene toolkit for reproducible information retrieval research
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/io/anserini/ann/lexlsh/LexicalLshTruncateTokenFilter.java b/src/main/java/io/anserini/ann/lexlsh/LexicalLshTruncateTokenFilter.java
@@ -1,5 +1,5 @@
 /*
- * Anserini: A Lucene toolkit for replicable information retrieval research
+ * Anserini: A Lucene toolkit for reproducible information retrieval research
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/io/anserini/collection/AclAnthology.java b/src/main/java/io/anserini/collection/AclAnthology.java
@@ -1,5 +1,5 @@
 /*
- * Anserini: A Lucene toolkit for replicable information retrieval research
+ * Anserini: A Lucene toolkit for reproducible information retrieval research
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/io/anserini/collection/BibtexCollection.java b/src/main/java/io/anserini/collection/BibtexCollection.java
@@ -1,5 +1,5 @@
 /*
- * Anserini: A Lucene toolkit for replicable information retrieval research
+ * Anserini: A Lucene toolkit for reproducible information retrieval research
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/io/anserini/collection/C4Collection.java b/src/main/java/io/anserini/collection/C4Collection.java
@@ -1,5 +1,5 @@
 /*
- * Anserini: A Lucene toolkit for replicable information retrieval research
+ * Anserini: A Lucene toolkit for reproducible information retrieval research
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -20,19 +20,21 @@
 import com.fasterxml.jackson.databind.MappingIterator;
 import com.fasterxml.jackson.databind.ObjectMapper;
 
-import java.io.*;
+import java.io.BufferedReader;
+import java.io.FileInputStream;
+import java.io.FilterInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.InputStreamReader;
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.StandardOpenOption;
-import java.text.DateFormat;
-import java.text.SimpleDateFormat;
+import java.time.Instant;
 import java.util.List;
 import java.util.NoSuchElementException;
 import java.util.stream.Collectors;
 import java.util.zip.GZIPInputStream;
-import java.util.Date;
-import java.time.Instant;
 
 
 public class C4Collection extends DocumentCollection<C4Collection.Document> {

diff --git a/src/main/java/io/anserini/collection/CarCollection.java b/src/main/java/io/anserini/collection/CarCollection.java
@@ -1,5 +1,5 @@
 /*
- * Anserini: A Lucene toolkit for replicable information retrieval research
+ * Anserini: A Lucene toolkit for reproducible information retrieval research
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/io/anserini/collection/CleanTrecCollection.java b/src/main/java/io/anserini/collection/CleanTrecCollection.java
@@ -1,5 +1,5 @@
 /*
- * Anserini: A Lucene toolkit for replicable information retrieval research
+ * Anserini: A Lucene toolkit for reproducible information retrieval research
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/io/anserini/collection/ClueWeb09Collection.java b/src/main/java/io/anserini/collection/ClueWeb09Collection.java
@@ -1,5 +1,5 @@
 /*
- * Anserini: A Lucene toolkit for replicable information retrieval research
+ * Anserini: A Lucene toolkit for reproducible information retrieval research
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/io/anserini/collection/ClueWeb12Collection.java b/src/main/java/io/anserini/collection/ClueWeb12Collection.java
@@ -1,5 +1,5 @@
 /*
- * Anserini: A Lucene toolkit for replicable information retrieval research
+ * Anserini: A Lucene toolkit for reproducible information retrieval research
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/io/anserini/collection/CommonCrawlNewsEnWarcCollection.java b/src/main/java/io/anserini/collection/CommonCrawlNewsEnWarcCollection.java
@@ -1,5 +1,5 @@
 /*
- * Anserini: A Lucene toolkit for replicable information retrieval research
+ * Anserini: A Lucene toolkit for reproducible information retrieval research
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -12,7 +12,6 @@
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
- *
  */
 
 package io.anserini.collection;

diff --git a/src/main/java/io/anserini/collection/CommonCrawlWarcCollection.java b/src/main/java/io/anserini/collection/CommonCrawlWarcCollection.java
@@ -1,5 +1,5 @@
 /*
- * Anserini: A Lucene toolkit for replicable information retrieval research
+ * Anserini: A Lucene toolkit for reproducible information retrieval research
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -12,7 +12,6 @@
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
- *
  */
 
 package io.anserini.collection;

diff --git a/src/main/java/io/anserini/collection/CommonCrawlWetCollection.java b/src/main/java/io/anserini/collection/CommonCrawlWetCollection.java
@@ -1,5 +1,5 @@
 /*
- * Anserini: A Lucene toolkit for replicable information retrieval research
+ * Anserini: A Lucene toolkit for reproducible information retrieval research
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -12,7 +12,6 @@
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
- *
  */
 
 package io.anserini.collection;

diff --git a/src/main/java/io/anserini/collection/Cord19AbstractCollection.java b/src/main/java/io/anserini/collection/Cord19AbstractCollection.java
@@ -1,5 +1,5 @@
 /*
- * Anserini: A Lucene toolkit for replicable information retrieval research
+ * Anserini: A Lucene toolkit for reproducible information retrieval research
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/io/anserini/collection/Cord19BaseDocument.java b/src/main/java/io/anserini/collection/Cord19BaseDocument.java
@@ -1,5 +1,5 @@
 /*
- * Anserini: A Lucene toolkit for replicable information retrieval research
+ * Anserini: A Lucene toolkit for reproducible information retrieval research
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/io/anserini/collection/Cord19FullTextCollection.java b/src/main/java/io/anserini/collection/Cord19FullTextCollection.java
@@ -1,5 +1,5 @@
 /*
- * Anserini: A Lucene toolkit for replicable information retrieval research
+ * Anserini: A Lucene toolkit for reproducible information retrieval research
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/io/anserini/collection/Cord19ParagraphCollection.java b/src/main/java/io/anserini/collection/Cord19ParagraphCollection.java
@@ -1,5 +1,5 @@
 /*
- * Anserini: A Lucene toolkit for replicable information retrieval research
+ * Anserini: A Lucene toolkit for reproducible information retrieval research
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/io/anserini/collection/CoreCollection.java b/src/main/java/io/anserini/collection/CoreCollection.java
@@ -1,5 +1,5 @@
 /*
- * Anserini: A Lucene toolkit for replicable information retrieval research
+ * Anserini: A Lucene toolkit for reproducible information retrieval research
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/io/anserini/collection/DocumentCollection.java b/src/main/java/io/anserini/collection/DocumentCollection.java
@@ -1,5 +1,5 @@
 /*
- * Anserini: A Lucene toolkit for replicable information retrieval research
+ * Anserini: A Lucene toolkit for reproducible information retrieval research
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/io/anserini/collection/EpidemicQACollection.java b/src/main/java/io/anserini/collection/EpidemicQACollection.java
@@ -1,5 +1,5 @@
 /*
- * Anserini: A Lucene toolkit for replicable information retrieval research
+ * Anserini: A Lucene toolkit for reproducible information retrieval research
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/io/anserini/collection/FeverBaseDocument.java b/src/main/java/io/anserini/collection/FeverBaseDocument.java
@@ -1,5 +1,5 @@
 /*
- * Anserini: A Lucene toolkit for replicable information retrieval research
+ * Anserini: A Lucene toolkit for reproducible information retrieval research
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/io/anserini/collection/FeverParagraphCollection.java b/src/main/java/io/anserini/collection/FeverParagraphCollection.java
@@ -1,5 +1,5 @@
 /*
- * Anserini: A Lucene toolkit for replicable information retrieval research
+ * Anserini: A Lucene toolkit for reproducible information retrieval research
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/io/anserini/collection/FeverSentenceCollection.java b/src/main/java/io/anserini/collection/FeverSentenceCollection.java
@@ -1,5 +1,5 @@
 /*
- * Anserini: A Lucene toolkit for replicable information retrieval research
+ * Anserini: A Lucene toolkit for reproducible information retrieval research
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -27,7 +27,13 @@
 import java.io.FileReader;
 import java.io.IOException;
 import java.nio.file.Path;
-import java.util.*;
+import java.util.ArrayList;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+import java.util.NoSuchElementException;
+import java.util.Objects;
+import java.util.Set;
 import java.util.stream.Stream;
 
 public class FeverSentenceCollection extends DocumentCollection<FeverSentenceCollection.Document> {

diff --git a/src/main/java/io/anserini/collection/FileSegment.java b/src/main/java/io/anserini/collection/FileSegment.java
@@ -1,5 +1,5 @@
 /*
- * Anserini: A Lucene toolkit for replicable information retrieval research
+ * Anserini: A Lucene toolkit for reproducible information retrieval research
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/io/anserini/collection/HtmlCollection.java b/src/main/java/io/anserini/collection/HtmlCollection.java
@@ -1,5 +1,5 @@
 /*
- * Anserini: A Lucene toolkit for replicable information retrieval research
+ * Anserini: A Lucene toolkit for reproducible information retrieval research
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/io/anserini/collection/InvalidContentsException.java b/src/main/java/io/anserini/collection/InvalidContentsException.java
@@ -1,5 +1,5 @@
 /*
- * Anserini: A Lucene toolkit for replicable information retrieval research
+ * Anserini: A Lucene toolkit for reproducible information retrieval research
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/io/anserini/collection/Iso19115Collection.java b/src/main/java/io/anserini/collection/Iso19115Collection.java
@@ -1,5 +1,5 @@
 /*
- * Anserini: A Lucene toolkit for replicable information retrieval research
+ * Anserini: A Lucene toolkit for reproducible information retrieval research
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -22,7 +22,6 @@
 
 import java.io.BufferedReader;
 import java.io.FileReader;
-import java.lang.StringBuilder;
 import java.io.IOException;
 import java.nio.file.Path;
 import java.util.Arrays;

diff --git a/src/main/java/io/anserini/collection/JsonCollection.java b/src/main/java/io/anserini/collection/JsonCollection.java
@@ -1,5 +1,5 @@
 /*
- * Anserini: A Lucene toolkit for replicable information retrieval research
+ * Anserini: A Lucene toolkit for reproducible information retrieval research
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/io/anserini/collection/JsoupStringTransform.java b/src/main/java/io/anserini/collection/JsoupStringTransform.java
@@ -1,5 +1,5 @@
 /*
- * Anserini: A Lucene toolkit for replicable information retrieval research
+ * Anserini: A Lucene toolkit for reproducible information retrieval research
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/io/anserini/collection/MultifieldSourceDocument.java b/src/main/java/io/anserini/collection/MultifieldSourceDocument.java
@@ -1,5 +1,5 @@
 /*
- * Anserini: A Lucene toolkit for replicable information retrieval research
+ * Anserini: A Lucene toolkit for reproducible information retrieval research
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/io/anserini/collection/NewYorkTimesCollection.java b/src/main/java/io/anserini/collection/NewYorkTimesCollection.java
@@ -1,5 +1,5 @@
 /*
- * Anserini: A Lucene toolkit for replicable information retrieval research
+ * Anserini: A Lucene toolkit for reproducible information retrieval research
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/io/anserini/collection/SourceDocument.java b/src/main/java/io/anserini/collection/SourceDocument.java
@@ -1,5 +1,5 @@
 /*
- * Anserini: A Lucene toolkit for replicable information retrieval research
+ * Anserini: A Lucene toolkit for reproducible information retrieval research
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

diff --git a/src/main/java/io/anserini/collection/StringTransform.java b/src/main/java/io/anserini/collection/StringTransform.java
@@ -1,5 +1,5 @@
 /*
- * Anserini: A Lucene toolkit for replicable information retrieval research
+ * Anserini: A Lucene toolkit for reproducible information retrieval research
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.