forked from elastic/elasticsearch
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[ML] adds new n_gram_encoding custom processor (elastic#61578)
This adds a new `n_gram_encoding` feature processor for analytics and inference. The focus of this processor is simple ngram encodings that allow: - multiple ngrams [1..5] - Prefix, infix, suffix
- Loading branch information
Showing
9 changed files
with
1,006 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
211 changes: 211 additions & 0 deletions
211
...t-high-level/src/main/java/org/elasticsearch/client/ml/inference/preprocessing/NGram.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,211 @@ | ||
| /* | ||
| * Licensed to Elasticsearch under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch licenses this file to you under | ||
| * the Apache License, Version 2.0 (the "License"); you may | ||
| * not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, 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 org.elasticsearch.client.ml.inference.preprocessing; | ||
|
|
||
| import org.elasticsearch.common.ParseField; | ||
| import org.elasticsearch.common.xcontent.ConstructingObjectParser; | ||
| import org.elasticsearch.common.xcontent.XContentBuilder; | ||
| import org.elasticsearch.common.xcontent.XContentParser; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.List; | ||
| import java.util.Objects; | ||
|
|
||
|
|
||
| /** | ||
| * PreProcessor for n-gram encoding a string | ||
| */ | ||
| public class NGram implements PreProcessor { | ||
|
|
||
| public static final String NAME = "n_gram_encoding"; | ||
| public static final ParseField FIELD = new ParseField("field"); | ||
| public static final ParseField FEATURE_PREFIX = new ParseField("feature_prefix"); | ||
| public static final ParseField NGRAMS = new ParseField("n_grams"); | ||
| public static final ParseField START = new ParseField("start"); | ||
| public static final ParseField LENGTH = new ParseField("length"); | ||
| public static final ParseField CUSTOM = new ParseField("custom"); | ||
|
|
||
| @SuppressWarnings("unchecked") | ||
| private static final ConstructingObjectParser<NGram, Void> PARSER = new ConstructingObjectParser<NGram, Void>( | ||
| NAME, | ||
| true, | ||
| a -> new NGram((String)a[0], | ||
| (List<Integer>)a[1], | ||
| (Integer)a[2], | ||
| (Integer)a[3], | ||
| (Boolean)a[4], | ||
| (String)a[5])); | ||
| static { | ||
| PARSER.declareString(ConstructingObjectParser.constructorArg(), FIELD); | ||
| PARSER.declareIntArray(ConstructingObjectParser.constructorArg(), NGRAMS); | ||
| PARSER.declareInt(ConstructingObjectParser.optionalConstructorArg(), START); | ||
| PARSER.declareInt(ConstructingObjectParser.optionalConstructorArg(), LENGTH); | ||
| PARSER.declareBoolean(ConstructingObjectParser.optionalConstructorArg(), CUSTOM); | ||
| PARSER.declareString(ConstructingObjectParser.optionalConstructorArg(), FEATURE_PREFIX); | ||
| } | ||
|
|
||
| public static NGram fromXContent(XContentParser parser) { | ||
| return PARSER.apply(parser, null); | ||
| } | ||
|
|
||
| private final String field; | ||
| private final String featurePrefix; | ||
| private final List<Integer> nGrams; | ||
| private final Integer start; | ||
| private final Integer length; | ||
| private final Boolean custom; | ||
|
|
||
| NGram(String field, List<Integer> nGrams, Integer start, Integer length, Boolean custom, String featurePrefix) { | ||
| this.field = field; | ||
| this.featurePrefix = featurePrefix; | ||
| this.nGrams = nGrams; | ||
| this.start = start; | ||
| this.length = length; | ||
| this.custom = custom; | ||
| } | ||
|
|
||
| @Override | ||
| public String getName() { | ||
| return NAME; | ||
| } | ||
|
|
||
| @Override | ||
| public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException { | ||
| builder.startObject(); | ||
| if (field != null) { | ||
| builder.field(FIELD.getPreferredName(), field); | ||
| } | ||
| if (featurePrefix != null) { | ||
| builder.field(FEATURE_PREFIX.getPreferredName(), featurePrefix); | ||
| } | ||
| if (nGrams != null) { | ||
| builder.field(NGRAMS.getPreferredName(), nGrams); | ||
| } | ||
| if (start != null) { | ||
| builder.field(START.getPreferredName(), start); | ||
| } | ||
| if (length != null) { | ||
| builder.field(LENGTH.getPreferredName(), length); | ||
| } | ||
| if (custom != null) { | ||
| builder.field(CUSTOM.getPreferredName(), custom); | ||
| } | ||
| builder.endObject(); | ||
| return builder; | ||
| } | ||
|
|
||
| public String getField() { | ||
| return field; | ||
| } | ||
|
|
||
| public String getFeaturePrefix() { | ||
| return featurePrefix; | ||
| } | ||
|
|
||
| public List<Integer> getnGrams() { | ||
| return nGrams; | ||
| } | ||
|
|
||
| public Integer getStart() { | ||
| return start; | ||
| } | ||
|
|
||
| public Integer getLength() { | ||
| return length; | ||
| } | ||
|
|
||
| public Boolean getCustom() { | ||
| return custom; | ||
| } | ||
|
|
||
| @Override | ||
| public boolean equals(Object o) { | ||
| if (this == o) return true; | ||
| if (o == null || getClass() != o.getClass()) return false; | ||
| NGram nGram = (NGram) o; | ||
| return Objects.equals(field, nGram.field) && | ||
| Objects.equals(featurePrefix, nGram.featurePrefix) && | ||
| Objects.equals(nGrams, nGram.nGrams) && | ||
| Objects.equals(start, nGram.start) && | ||
| Objects.equals(length, nGram.length) && | ||
| Objects.equals(custom, nGram.custom); | ||
| } | ||
|
|
||
| @Override | ||
| public int hashCode() { | ||
| return Objects.hash(field, featurePrefix, start, length, custom, nGrams); | ||
| } | ||
|
|
||
| public static Builder builder(String field) { | ||
| return new Builder(field); | ||
| } | ||
|
|
||
| public static class Builder { | ||
|
|
||
| private String field; | ||
| private String featurePrefix; | ||
| private List<Integer> nGrams; | ||
| private Integer start; | ||
| private Integer length; | ||
| private Boolean custom; | ||
|
|
||
| public Builder(String field) { | ||
| this.field = field; | ||
| } | ||
|
|
||
| public Builder setField(String field) { | ||
| this.field = field; | ||
| return this; | ||
| } | ||
|
|
||
| public Builder setCustom(boolean custom) { | ||
| this.custom = custom; | ||
| return this; | ||
| } | ||
|
|
||
| public Builder setFeaturePrefix(String featurePrefix) { | ||
| this.featurePrefix = featurePrefix; | ||
| return this; | ||
| } | ||
|
|
||
| public Builder setnGrams(List<Integer> nGrams) { | ||
| this.nGrams = nGrams; | ||
| return this; | ||
| } | ||
|
|
||
| public Builder setStart(Integer start) { | ||
| this.start = start; | ||
| return this; | ||
| } | ||
|
|
||
| public Builder setLength(Integer length) { | ||
| this.length = length; | ||
| return this; | ||
| } | ||
|
|
||
| public Builder setCustom(Boolean custom) { | ||
| this.custom = custom; | ||
| return this; | ||
| } | ||
|
|
||
| public NGram build() { | ||
| return new NGram(field, nGrams, start, length, custom, featurePrefix); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
55 changes: 55 additions & 0 deletions
55
...h-level/src/test/java/org/elasticsearch/client/ml/inference/preprocessing/NGramTests.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,55 @@ | ||
| /* | ||
| * Licensed to Elasticsearch under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch licenses this file to you under | ||
| * the Apache License, Version 2.0 (the "License"); you may | ||
| * not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, 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 org.elasticsearch.client.ml.inference.preprocessing; | ||
|
|
||
| import org.elasticsearch.common.xcontent.XContentParser; | ||
| import org.elasticsearch.test.AbstractXContentTestCase; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.stream.Collectors; | ||
| import java.util.stream.IntStream; | ||
|
|
||
|
|
||
| public class NGramTests extends AbstractXContentTestCase<NGram> { | ||
|
|
||
| @Override | ||
| protected NGram doParseInstance(XContentParser parser) throws IOException { | ||
| return NGram.fromXContent(parser); | ||
| } | ||
|
|
||
| @Override | ||
| protected boolean supportsUnknownFields() { | ||
| return true; | ||
| } | ||
|
|
||
| @Override | ||
| protected NGram createTestInstance() { | ||
| return createRandom(); | ||
| } | ||
|
|
||
| public static NGram createRandom() { | ||
| return new NGram(randomAlphaOfLength(10), | ||
| IntStream.range(1, 5).limit(5).boxed().collect(Collectors.toList()), | ||
| randomBoolean() ? null : randomIntBetween(0, 10), | ||
| randomBoolean() ? null : randomIntBetween(1, 10), | ||
| randomBoolean() ? null : randomBoolean(), | ||
| randomBoolean() ? null : randomAlphaOfLength(10)); | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.