[ML] Add checkbox to enable model plot in Advanced job wizard #25468

alvarezmelissa87 · 2018-11-09T15:58:12Z

Summary

Related issue: #18164
Follow up to: #24914

Adds an Enable model plot checkbox in the Analysis Configuration tab in the Advanced job creation wizard. Creating a job with this checked sets "model_plot_config":{"enabled":true}. for that job.

Flow:

When Enable model plot is checked cardinality check is run. Callout is shown when cardinality is greater than the threshold (100).
Cardinality check is re-run when relevant fields change/are updated.
-- Changes made in Detectors area or from Add detector modal.
We keep track of the current detector and model_plot configs in currentConfigs and if changes occur via the Edit JSON tab, we update the ui and run cardinality again if enableModelPlot is set to true and detectors have been updated.
If Cardinality validation errors for some reason - still show warning message so user is aware of risk in enabling model plot.
Use dedicated index is NOT automatically checked when cardinality returns a warning. This option is in a separate tab and, therefore, may not be seen by the user so we don't change it.
Also adds better error handling for MultiMetric + Population wizards by still showing callout with warning message.

Checklist

Use ~~strikethroughs~~ to remove checklist items you don't feel are applicable to this PR.

This was checked for cross-browser compatibility, including a check against IE11
~~- [ ] Any text added follows EUI's writing guidelines, uses sentence case text and includes i18n support~~
~~- [ ] Documentation was added for features that require explanation or tutorials~~
Unit or functional tests were updated or added to match the most common scenarios
This was checked for keyboard-only and screenreader accessibility

For maintainers

~~- [ ] This was checked for breaking API changes and was labeled appropriately~~
~~- [ ] This includes a feature addition or change that requires a release note and was labeled appropriately~~

elasticmachine · 2018-11-09T15:58:14Z

Pinging @elastic/ml-ui

peteharverson · 2018-11-09T16:18:58Z

x-pack/plugins/ml/public/jobs/new_job/advanced/new_job_controller.js

+            $scope.ui.cardinalityValidator.message = `Creating model plots is resource intensive and not recommended
+                  where the cardinality of the selected fields is greater than 100. Estimated cardinality
+                  for this job is ${validationResult.highCardinality}.
+                  If you enable model plot with this configuration we recommend you use a dedicated results index.`;


Probably worth adding where that dedicated results index is configured. Something like If you enable model plot with this configuration we recommend you select a dedicated results index on the Job Details tab. ?

Do you mean as a warning callout as well?

peteharverson · 2018-11-09T16:24:29Z

x-pack/plugins/ml/public/jobs/new_job/advanced/new_job_controller.js

+            $scope.ui.cardinalityValidator.status = STATUS.WARNING;
+          }
+        })
+        .catch((error) => { console.log('Cardinality check error:', error); });


Is it worth displaying some sort of warning in the same callout for the error case. Something like An error occurred validating the configuration for running the job with model plot enabled. Creating model plots can be resource intensive and not recommended where the cardinality of the selected fields is high. You may want to select a dedicated results index on the Job Details tab.

Good one, @peteharverson! 😄 I'll go back and add this to the other wizards as well in a subsequent PR

peteharverson · 2018-11-09T16:28:40Z

x-pack/plugins/ml/public/jobs/new_job/utils/new_job_utils.js

+  return response;
+}
+
+export function getMinimalValidJob() {


Can you add a comment to say when this function would be used

elasticmachine · 2018-11-09T18:13:35Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

elasticmachine · 2018-11-09T22:16:14Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

elasticmachine · 2018-11-10T00:15:07Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

walterra

LGTM!

peteharverson · 2018-11-12T14:53:54Z

.../ml/public/jobs/new_job/advanced/enable_model_plot_callout/enable_model_plot_callout_view.js

+} from '@elastic/eui';
+
+
+export const EnableModelPlotCallout = ({ message }) => (


We should probably have a unit test for this component, even though it is fairly simple.

elasticmachine · 2018-11-16T17:47:09Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

peteharverson

Latest changes LGTM

alvarezmelissa87 · 2018-11-16T17:56:39Z

retest

elasticmachine · 2018-11-16T17:58:58Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request

elasticmachine · 2018-11-16T20:46:47Z

💚 Build Succeeded

continuous-integration/kibana-ci/pull-request

…c#25468) * Move cardinality success check to utils * enableModelPlot checkbox base added * Run cardinality check on add/update fields * Handle changes made via json * only run cardinality check if model plot enabled * Handle model plot enabled via EditJSON tab * show message on cardinality check error * multi-metric + pop: show message on cardinality check error * add test for callout component * Fix flexitem overflow in IE11

#25831) * Move cardinality success check to utils * enableModelPlot checkbox base added * Run cardinality check on add/update fields * Handle changes made via json * only run cardinality check if model plot enabled * Handle model plot enabled via EditJSON tab * show message on cardinality check error * multi-metric + pop: show message on cardinality check error * add test for callout component * Fix flexitem overflow in IE11

alvarezmelissa87 added release_note:enhancement review :ml Feature:Anomaly Detection ML anomaly detection v6.6.0 labels Nov 9, 2018

alvarezmelissa87 requested review from walterra, peteharverson and jgowdyelastic November 9, 2018 15:58

peteharverson reviewed Nov 9, 2018

View reviewed changes

walterra approved these changes Nov 12, 2018

View reviewed changes

peteharverson reviewed Nov 12, 2018

View reviewed changes

peteharverson approved these changes Nov 16, 2018

View reviewed changes

alvarezmelissa87 added 9 commits November 16, 2018 10:02

Move cardinality success check to utils

0ed01e8

enableModelPlot checkbox base added

b506f85

Run cardinality check on add/update fields

b2cf90b

Handle changes made via json

e2bdf4c

only run cardinality check if model plot enabled

826d9d0

Handle model plot enabled via EditJSON tab

4c5006c

show message on cardinality check error

e04f92d

multi-metric + pop: show message on cardinality check error

b28d318

add test for callout component

aefa3e3

alvarezmelissa87 force-pushed the ml-configure-model-plot-advanced branch from 4c16507 to aefa3e3 Compare November 16, 2018 18:04

Fix flexitem overflow in IE11

fa6c040

alvarezmelissa87 merged commit 354d7cc into elastic:master Nov 16, 2018

alvarezmelissa87 mentioned this pull request Nov 16, 2018

[6.x] [ML] Add checkbox to enable model plot in Advanced job wizard (#25468) #25831

Merged

alvarezmelissa87 deleted the ml-configure-model-plot-advanced branch November 16, 2018 21:48

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ML] Add checkbox to enable model plot in Advanced job wizard #25468

[ML] Add checkbox to enable model plot in Advanced job wizard #25468

alvarezmelissa87 commented Nov 9, 2018 •

edited

Loading

elasticmachine commented Nov 9, 2018

peteharverson Nov 9, 2018

alvarezmelissa87 Nov 9, 2018

peteharverson Nov 9, 2018

alvarezmelissa87 Nov 9, 2018

peteharverson Nov 9, 2018

elasticmachine commented Nov 9, 2018

elasticmachine commented Nov 9, 2018

elasticmachine commented Nov 10, 2018

walterra left a comment

peteharverson Nov 12, 2018

elasticmachine commented Nov 16, 2018

peteharverson left a comment

alvarezmelissa87 commented Nov 16, 2018

elasticmachine commented Nov 16, 2018

elasticmachine commented Nov 16, 2018

		} from '@elastic/eui';


		export const EnableModelPlotCallout = ({ message }) => (

[ML] Add checkbox to enable model plot in Advanced job wizard #25468

[ML] Add checkbox to enable model plot in Advanced job wizard #25468

Conversation

alvarezmelissa87 commented Nov 9, 2018 • edited Loading

Summary

Flow:

Checklist

For maintainers

elasticmachine commented Nov 9, 2018

peteharverson Nov 9, 2018

Choose a reason for hiding this comment

alvarezmelissa87 Nov 9, 2018

Choose a reason for hiding this comment

peteharverson Nov 9, 2018

Choose a reason for hiding this comment

alvarezmelissa87 Nov 9, 2018

Choose a reason for hiding this comment

peteharverson Nov 9, 2018

Choose a reason for hiding this comment

elasticmachine commented Nov 9, 2018

💚 Build Succeeded

elasticmachine commented Nov 9, 2018

💚 Build Succeeded

elasticmachine commented Nov 10, 2018

💚 Build Succeeded

walterra left a comment

Choose a reason for hiding this comment

peteharverson Nov 12, 2018

Choose a reason for hiding this comment

elasticmachine commented Nov 16, 2018

💔 Build Failed

peteharverson left a comment

Choose a reason for hiding this comment

alvarezmelissa87 commented Nov 16, 2018

elasticmachine commented Nov 16, 2018

💔 Build Failed

elasticmachine commented Nov 16, 2018

💚 Build Succeeded

alvarezmelissa87 commented Nov 9, 2018 •

edited

Loading