-
Notifications
You must be signed in to change notification settings - Fork 8.3k
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.
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
[ML] Add switch to enable model plot annotations independently #70678
Changes from 6 commits
e7411f7
1b54be9
327c3e2
42d9697
b49baf1
405c2a7
fcb1bab
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,65 @@ | ||
/* | ||
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
* or more contributor license agreements. Licensed under the Elastic License; | ||
* you may not use this file except in compliance with the Elastic License. | ||
*/ | ||
|
||
import React, { FC, useState, useContext, useEffect } from 'react'; | ||
import { i18n } from '@kbn/i18n'; | ||
import { EuiCallOut, EuiSpacer, EuiSwitch } from '@elastic/eui'; | ||
import { FormattedMessage } from '@kbn/i18n/react'; | ||
import { JobCreatorContext } from '../../../../../job_creator_context'; | ||
import { Description } from './description'; | ||
|
||
export const AnnotationsSwitch: FC = () => { | ||
const { jobCreator, jobCreatorUpdate, jobCreatorUpdated } = useContext(JobCreatorContext); | ||
const [annotationsEnabled, setAnnotationsEnabled] = useState(jobCreator.modelChangeAnnotations); | ||
const [showCallOut, setShowCallout] = useState( | ||
jobCreator.modelPlot && !jobCreator.modelChangeAnnotations | ||
); | ||
|
||
useEffect(() => { | ||
jobCreator.modelChangeAnnotations = annotationsEnabled; | ||
jobCreatorUpdate(); | ||
}, [annotationsEnabled]); | ||
|
||
useEffect(() => { | ||
setShowCallout(jobCreator.modelPlot && !annotationsEnabled); | ||
}, [jobCreatorUpdated, annotationsEnabled]); | ||
|
||
function toggleAnnotations() { | ||
setAnnotationsEnabled(!annotationsEnabled); | ||
} | ||
|
||
return ( | ||
<> | ||
<Description> | ||
<EuiSwitch | ||
name="switch" | ||
checked={annotationsEnabled} | ||
onChange={toggleAnnotations} | ||
data-test-subj="mlJobWizardSwitchAnnotations" | ||
label={i18n.translate( | ||
'xpack.ml.newJob.wizard.jobDetailsStep.advancedSection.enableModelPlotAnnotations.title', | ||
{ | ||
defaultMessage: 'Enable model change annotations', | ||
} | ||
)} | ||
/> | ||
</Description> | ||
{showCallOut && ( | ||
<EuiCallOut | ||
title={ | ||
<FormattedMessage | ||
id="xpack.ml.newJob.wizard.jobDetailsStep.advancedSection.annotationsSwitchCallout.title" | ||
defaultMessage="If you enable model plot with this configuration, we recommend you also enable annotations." | ||
/> | ||
} | ||
color="primary" | ||
iconType="help" | ||
/> | ||
)} | ||
<EuiSpacer /> | ||
</> | ||
); | ||
}; |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
/* | ||
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
* or more contributor license agreements. Licensed under the Elastic License; | ||
* you may not use this file except in compliance with the Elastic License. | ||
*/ | ||
|
||
import React, { memo, FC } from 'react'; | ||
import { i18n } from '@kbn/i18n'; | ||
import { FormattedMessage } from '@kbn/i18n/react'; | ||
import { EuiDescribedFormGroup, EuiFormRow } from '@elastic/eui'; | ||
|
||
export const Description: FC = memo(({ children }) => { | ||
const title = i18n.translate( | ||
'xpack.ml.newJob.wizard.jobDetailsStep.advancedSection.enableModelPlotAnnotations.title', | ||
{ | ||
defaultMessage: 'Enable model change annotations', | ||
} | ||
); | ||
return ( | ||
<EuiDescribedFormGroup | ||
title={<h3>{title}</h3>} | ||
description={ | ||
<FormattedMessage | ||
id="xpack.ml.newJob.wizard.jobDetailsStep.advancedSection.enableModelPlotAnnotations.description" | ||
defaultMessage="Select to generate annotations when the model changes significantly. For example, when step changes, periodicity or trends are detected." | ||
/> | ||
} | ||
> | ||
<EuiFormRow label={title}> | ||
<>{children}</> | ||
</EuiFormRow> | ||
</EuiDescribedFormGroup> | ||
); | ||
}); |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
/* | ||
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
* or more contributor license agreements. Licensed under the Elastic License; | ||
* you may not use this file except in compliance with the Elastic License. | ||
*/ | ||
|
||
export { AnnotationsSwitch } from './annotations_switch'; |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -125,6 +125,7 @@ export const Page: FC<PageProps> = ({ existingJobsAndGroups, jobType }) => { | |
|
||
if (jobCreator.type === JOB_TYPE.SINGLE_METRIC) { | ||
jobCreator.modelPlot = true; | ||
jobCreator.modelChangeAnnotations = true; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. do we definitely want to enabling this for all single metric jobs? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think just enabling As for why we wanted both on for SM jobs, the discussion was that we expect annotations to be fairly high volume for high cardinality jobs, but nowhere near as high volume as model plot. So if we can tolerate the volume of model plot, we would probably also want annotations. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
This is no longer possible with the changes you added in 405c2a7. So if we do want to only enable I was asking more from a product design point of view, whether this had been discussed and it sounds like it has. |
||
} | ||
|
||
if (mlContext.currentSavedSearch !== null) { | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,6 +5,7 @@ | |
*/ | ||
|
||
import { schema } from '@kbn/config-schema'; | ||
import { Job } from '../../common/types/anomaly_detection_jobs'; | ||
import { wrapError } from '../client/error_wrapper'; | ||
import { RouteInitialization } from '../types'; | ||
import { | ||
|
@@ -175,9 +176,11 @@ export function jobRoutes({ router, mlLicense }: RouteInitialization) { | |
mlLicense.fullLicenseAPIGuard(async (context, request, response) => { | ||
try { | ||
const { jobId } = request.params; | ||
const body: Partial<Job> = request.body; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. i don't think this is needed There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Removed here fcb1bab |
||
|
||
const results = await context.ml!.mlClient.callAsCurrentUser('ml.addJob', { | ||
jobId, | ||
body: request.body, | ||
body, | ||
}); | ||
return response.ok({ | ||
body: results, | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this can now be
this._job_config.model_plot_config.enabled = enable
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated here fcb1bab