Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move TermAndBoost back to its original location. #12366

Merged
merged 4 commits into from
Jun 14, 2023
Merged

Move TermAndBoost back to its original location. #12366

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
505be19
Move TermAndBoost back to its original location.
jpountz Jun 13, 2023
c330329
iter
jpountz Jun 13, 2023
e3a5b30
Reduce visibility
jpountz Jun 13, 2023
f9cb335
Revert "Reduce visibility"
jpountz Jun 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .../org/apache/lucene/util/TermAndBoost.java → ...alysis/synonym/word2vec/TermAndBoost.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,9 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.lucene.util;
package org.apache.lucene.analysis.synonym.word2vec;

import org.apache.lucene.util.BytesRef;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we make this class package private?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And even rename it so it does not get confused?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good call on reducing visibility. I tried to see if private worked and it did not, but I forgot to check if pkg-private would work, it does!

I think it's fine to use the same name, at least I don't want to give it a weird name for the sake of having a different name? E.g. we have lots of ScoreAndDoc classes across many packages and it's fine?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it makes sense, thanks!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I just noticed that Word2VecSynonymProvider is a public class the exposes TermAndBoost via the method #getSynonyms. So either we can make that method package private or we need to change the visibility of the class again.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would keep it public for now as it was before.


/** Wraps a term and boost */
public class TermAndBoost {
Expand Down
1 change: 0 additions & 1 deletion ...is/common/src/java/org/apache/lucene/analysis/synonym/word2vec/Word2VecSynonymFilter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@
import org.apache.lucene.analysis.tokenattributes.TypeAttribute;
import org.apache.lucene.util.BytesRef;
import org.apache.lucene.util.BytesRefBuilder;
import org.apache.lucene.util.TermAndBoost;

/**
* Applies single-token synonyms from a Word2Vec trained network to an incoming {@link TokenStream}.
Expand Down
1 change: 0 additions & 1 deletion .../common/src/java/org/apache/lucene/analysis/synonym/word2vec/Word2VecSynonymProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
import org.apache.lucene.index.VectorEncoding;
import org.apache.lucene.index.VectorSimilarityFunction;
import org.apache.lucene.util.BytesRef;
import org.apache.lucene.util.TermAndBoost;
import org.apache.lucene.util.hnsw.HnswGraphBuilder;
import org.apache.lucene.util.hnsw.HnswGraphSearcher;
import org.apache.lucene.util.hnsw.NeighborQueue;
Expand Down
1 change: 0 additions & 1 deletion ...mon/src/test/org/apache/lucene/analysis/synonym/word2vec/TestWord2VecSynonymProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@
import java.util.List;
import org.apache.lucene.tests.util.LuceneTestCase;
import org.apache.lucene.util.BytesRef;
import org.apache.lucene.util.TermAndBoost;
import org.apache.lucene.util.TermAndVector;
import org.junit.Test;

Expand Down
14 changes: 14 additions & 0 deletions lucene/core/src/java/org/apache/lucene/util/QueryBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,20 @@ public class QueryBuilder {
protected boolean enableGraphQueries = true;
protected boolean autoGenerateMultiTermSynonymsPhraseQuery = false;

/** Wraps a term and boost */
public static class TermAndBoost {
/** the term */
public final BytesRef term;
/** the boost */
public final float boost;

/** Creates a new TermAndBoost */
public TermAndBoost(BytesRef term, float boost) {
this.term = BytesRef.deepCopyOf(term);
this.boost = boost;
}
}

/** Creates a new QueryBuilder using the given analyzer. */
public QueryBuilder(Analyzer analyzer) {
this.analyzer = analyzer;
Expand Down