-
Notifications
You must be signed in to change notification settings - Fork 24.7k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[ML] Add a model memory estimation endpoint for anomaly detection (#5…
…3507) A new endpoint for estimating anomaly detection job model memory requirements: POST _ml/anomaly_detectors/estimate_model_memory Closes #53219
- Loading branch information
1 parent
2a67bee
commit 8ee7705
Showing
14 changed files
with
669 additions
and
31 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
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
110 changes: 110 additions & 0 deletions
110
...rest-high-level/src/main/java/org/elasticsearch/client/ml/EstimateModelMemoryRequest.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,110 @@ | ||
/* | ||
* 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; | ||
|
||
import org.elasticsearch.client.Validatable; | ||
import org.elasticsearch.client.ValidationException; | ||
import org.elasticsearch.client.ml.job.config.AnalysisConfig; | ||
import org.elasticsearch.common.xcontent.ToXContentObject; | ||
import org.elasticsearch.common.xcontent.XContentBuilder; | ||
|
||
import java.io.IOException; | ||
import java.util.Collections; | ||
import java.util.Map; | ||
import java.util.Objects; | ||
import java.util.Optional; | ||
|
||
/** | ||
* Request to estimate the model memory an analysis config is likely to need given supplied field cardinalities. | ||
*/ | ||
public class EstimateModelMemoryRequest implements Validatable, ToXContentObject { | ||
|
||
public static final String ANALYSIS_CONFIG = "analysis_config"; | ||
public static final String OVERALL_CARDINALITY = "overall_cardinality"; | ||
public static final String MAX_BUCKET_CARDINALITY = "max_bucket_cardinality"; | ||
|
||
private final AnalysisConfig analysisConfig; | ||
private Map<String, Long> overallCardinality = Collections.emptyMap(); | ||
private Map<String, Long> maxBucketCardinality = Collections.emptyMap(); | ||
|
||
@Override | ||
public Optional<ValidationException> validate() { | ||
return Optional.empty(); | ||
} | ||
|
||
public EstimateModelMemoryRequest(AnalysisConfig analysisConfig) { | ||
this.analysisConfig = Objects.requireNonNull(analysisConfig); | ||
} | ||
|
||
public AnalysisConfig getAnalysisConfig() { | ||
return analysisConfig; | ||
} | ||
|
||
public Map<String, Long> getOverallCardinality() { | ||
return overallCardinality; | ||
} | ||
|
||
public void setOverallCardinality(Map<String, Long> overallCardinality) { | ||
this.overallCardinality = Collections.unmodifiableMap(overallCardinality); | ||
} | ||
|
||
public Map<String, Long> getMaxBucketCardinality() { | ||
return maxBucketCardinality; | ||
} | ||
|
||
public void setMaxBucketCardinality(Map<String, Long> maxBucketCardinality) { | ||
this.maxBucketCardinality = Collections.unmodifiableMap(maxBucketCardinality); | ||
} | ||
|
||
@Override | ||
public XContentBuilder toXContent(XContentBuilder builder, Params params) throws IOException { | ||
builder.startObject(); | ||
builder.field(ANALYSIS_CONFIG, analysisConfig); | ||
if (overallCardinality.isEmpty() == false) { | ||
builder.field(OVERALL_CARDINALITY, overallCardinality); | ||
} | ||
if (maxBucketCardinality.isEmpty() == false) { | ||
builder.field(MAX_BUCKET_CARDINALITY, maxBucketCardinality); | ||
} | ||
builder.endObject(); | ||
return builder; | ||
} | ||
|
||
@Override | ||
public int hashCode() { | ||
return Objects.hash(analysisConfig, overallCardinality, maxBucketCardinality); | ||
} | ||
|
||
@Override | ||
public boolean equals(Object other) { | ||
if (this == other) { | ||
return true; | ||
} | ||
|
||
if (other == null || getClass() != other.getClass()) { | ||
return false; | ||
} | ||
|
||
EstimateModelMemoryRequest that = (EstimateModelMemoryRequest) other; | ||
return Objects.equals(analysisConfig, that.analysisConfig) && | ||
Objects.equals(overallCardinality, that.overallCardinality) && | ||
Objects.equals(maxBucketCardinality, that.maxBucketCardinality); | ||
} | ||
} |
80 changes: 80 additions & 0 deletions
80
...est-high-level/src/main/java/org/elasticsearch/client/ml/EstimateModelMemoryResponse.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,80 @@ | ||
/* | ||
* 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; | ||
|
||
import org.elasticsearch.common.ParseField; | ||
import org.elasticsearch.common.unit.ByteSizeValue; | ||
import org.elasticsearch.common.xcontent.ConstructingObjectParser; | ||
import org.elasticsearch.common.xcontent.XContentParser; | ||
|
||
import java.util.Objects; | ||
|
||
import static org.elasticsearch.common.xcontent.ConstructingObjectParser.constructorArg; | ||
|
||
public class EstimateModelMemoryResponse { | ||
|
||
public static final ParseField MODEL_MEMORY_ESTIMATE = new ParseField("model_memory_estimate"); | ||
|
||
static final ConstructingObjectParser<EstimateModelMemoryResponse, Void> PARSER = | ||
new ConstructingObjectParser<>( | ||
"estimate_model_memory", | ||
true, | ||
args -> new EstimateModelMemoryResponse((String) args[0])); | ||
|
||
static { | ||
PARSER.declareString(constructorArg(), MODEL_MEMORY_ESTIMATE); | ||
} | ||
|
||
public static EstimateModelMemoryResponse fromXContent(final XContentParser parser) { | ||
return PARSER.apply(parser, null); | ||
} | ||
|
||
private final ByteSizeValue modelMemoryEstimate; | ||
|
||
public EstimateModelMemoryResponse(String modelMemoryEstimate) { | ||
this.modelMemoryEstimate = ByteSizeValue.parseBytesSizeValue(modelMemoryEstimate, MODEL_MEMORY_ESTIMATE.getPreferredName()); | ||
} | ||
|
||
/** | ||
* @return An estimate of the model memory the supplied analysis config is likely to need given the supplied field cardinalities. | ||
*/ | ||
public ByteSizeValue getModelMemoryEstimate() { | ||
return modelMemoryEstimate; | ||
} | ||
|
||
@Override | ||
public boolean equals(Object o) { | ||
|
||
if (this == o) { | ||
return true; | ||
} | ||
if (o == null || getClass() != o.getClass()) { | ||
return false; | ||
} | ||
|
||
EstimateModelMemoryResponse other = (EstimateModelMemoryResponse) o; | ||
return Objects.equals(this.modelMemoryEstimate, other.modelMemoryEstimate); | ||
} | ||
|
||
@Override | ||
public int hashCode() { | ||
return Objects.hash(modelMemoryEstimate); | ||
} | ||
} |
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
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.