[ML] write deprecation warning when include_model_definition parameter is used #62834
Conversation
This file contains hidden or 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
Collaborator
|
Pinging @elastic/ml-core (:ml) |
benwtrent
force-pushed
the
feature/ml-get-model-deprecation-warning
branch
from
8c76b21 to
95ddf71
Compare
Member
Author
|
run elasticsearch-ci/packaging-sample-windows |
| features: "warnings" | ||
| - do: | ||
| warnings: | ||
| - "[include_model_definition] parameter is deprecated! Use parameter [include] and supply the flag 'definition' instead." |
Contributor
There was a problem hiding this comment.
I'm wondering if the wording here could be more direct and say sth like: "Use [include=definition] instead".
Member
Author
There was a problem hiding this comment.
I can update the message, for sure.
| "[{}] parameter is deprecated! Use parameter [{}] and supply the flag 'definition' instead.", | ||
| GetTrainedModelsAction.Request.INCLUDE_MODEL_DEFINITION, | ||
| GetTrainedModelsAction.Request.INCLUDE.getPreferredName()); | ||
| request = new GetTrainedModelsAction.Request(modelId, |
Contributor
There was a problem hiding this comment.
Should this constructor now go away?
public Request(String id, boolean includeModelDefinition, List<String> tags) {
Member
Author
There was a problem hiding this comment.
No, it's a convenience method for when the user calls with a deprecated flag. Consequently, itself is also deprecated.
przemekwitek
approved these changes
Sep 24, 2020
Contributor
przemekwitek
left a comment
przemekwitek
left a comment
There was a problem hiding this comment.
LGTM
Changes in the message do not require further review from my side.
benwtrent
commented
Sep 24, 2020
...n/ml/src/main/java/org/elasticsearch/xpack/ml/rest/inference/RestGetTrainedModelsAction.java
Outdated
Show resolved
Hide resolved
benwtrent
commented
Sep 24, 2020
x-pack/plugin/src/test/resources/rest-api-spec/test/ml/inference_crud.yml
Outdated
Show resolved
Hide resolved
benwtrent
added a commit
to benwtrent/elasticsearch
that referenced
this pull request
Sep 24, 2020
…r is used (elastic#62834) for get trained models include_model_definition is now deprecated. This commit writes a deprecation warning if that parameter is used and suggests the caller to utilize the replacement
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
for get trained models
include_model_definitionis now deprecated.This commit writes a deprecation warning if that parameter is used and suggests the caller to utilize the replacement