[ML] DF Analytics creation and update: adds max_num_threads (elasti…

…c#71318) * add max_num_threads to edit flyout * add maxNumThreads setting to job wizard * add maxNumThreads to cloning
alvarezmelissa87 · Jul 13, 2020 · 6b691b4 · 6b691b4
1 parent e02bbe4
commit 6b691b4
Show file tree

Hide file tree

Showing 9 changed files with 137 additions and 25 deletions.
diff --git a/x-pack/plugins/ml/public/application/data_frame_analytics/common/analytics.ts b/x-pack/plugins/ml/public/application/data_frame_analytics/common/analytics.ts
@@ -339,6 +339,7 @@ export interface UpdateDataFrameAnalyticsConfig {
   allow_lazy_start?: string;
   description?: string;
   model_memory_limit?: string;
+  max_num_threads?: number;
 }
 
 export interface DataFrameAnalyticsConfig {
@@ -358,6 +359,7 @@ export interface DataFrameAnalyticsConfig {
     excludes: string[];
   };
   model_memory_limit: string;
+  max_num_threads?: number;
   create_time: number;
   version: string;
   allow_lazy_start?: boolean;

diff --git a/...ame_analytics/pages/analytics_creation/components/advanced_step/advanced_step_details.tsx b/...ame_analytics/pages/analytics_creation/components/advanced_step/advanced_step_details.tsx
@@ -45,6 +45,7 @@ export const AdvancedStepDetails: FC<{ setCurrentStep: any; state: State }> = ({
     jobType,
     lambda,
     method,
+    maxNumThreads,
     maxTrees,
     modelMemoryLimit,
     nNeighbors,
@@ -214,6 +215,15 @@ export const AdvancedStepDetails: FC<{ setCurrentStep: any; state: State }> = ({
     );
   }
 
+  if (maxNumThreads !== undefined) {
+    advancedFirstCol.push({
+      title: i18n.translate('xpack.ml.dataframe.analytics.create.configDetails.maxNumThreads', {
+        defaultMessage: 'Maximum number of threads',
+      }),
+      description: `${maxNumThreads}`,
+    });
+  }
+
   return (
     <Fragment>
       <EuiTitle size="xs">

diff --git a/..._frame_analytics/pages/analytics_creation/components/advanced_step/advanced_step_form.tsx b/..._frame_analytics/pages/analytics_creation/components/advanced_step/advanced_step_form.tsx
@@ -9,7 +9,7 @@ import {
   EuiAccordion,
   EuiFieldNumber,
   EuiFieldText,
-  EuiFlexGroup,
+  EuiFlexGrid,
   EuiFlexItem,
   EuiFormRow,
   EuiSelect,
@@ -57,6 +57,7 @@ export const AdvancedStepForm: FC<CreateAnalyticsStepProps> = ({
     gamma,
     jobType,
     lambda,
+    maxNumThreads,
     maxTrees,
     method,
     modelMemoryLimit,
@@ -82,7 +83,8 @@ export const AdvancedStepForm: FC<CreateAnalyticsStepProps> = ({
   const isStepInvalid =
     mmlInvalid ||
     Object.keys(advancedParamErrors).length > 0 ||
-    fetchingAdvancedParamErrors === true;
+    fetchingAdvancedParamErrors === true ||
+    maxNumThreads === 0;
 
   useEffect(() => {
     setFetchingAdvancedParamErrors(true);
@@ -112,6 +114,7 @@ export const AdvancedStepForm: FC<CreateAnalyticsStepProps> = ({
     featureInfluenceThreshold,
     gamma,
     lambda,
+    maxNumThreads,
     maxTrees,
     method,
     nNeighbors,
@@ -123,7 +126,7 @@ export const AdvancedStepForm: FC<CreateAnalyticsStepProps> = ({
 
   const outlierDetectionAdvancedConfig = (
     <Fragment>
-      <EuiFlexItem style={{ minWidth: '30%' }}>
+      <EuiFlexItem>
         <EuiFormRow
           label={i18n.translate(
             'xpack.ml.dataframe.analytics.create.computeFeatureInfluenceLabel',
@@ -171,7 +174,7 @@ export const AdvancedStepForm: FC<CreateAnalyticsStepProps> = ({
           />
         </EuiFormRow>
       </EuiFlexItem>
-      <EuiFlexItem style={{ minWidth: '30%' }}>
+      <EuiFlexItem>
         <EuiFormRow
           label={i18n.translate(
             'xpack.ml.dataframe.analytics.create.featureInfluenceThresholdLabel',
@@ -210,7 +213,7 @@ export const AdvancedStepForm: FC<CreateAnalyticsStepProps> = ({
 
   const regAndClassAdvancedConfig = (
     <Fragment>
-      <EuiFlexItem style={{ minWidth: '30%' }}>
+      <EuiFlexItem>
         <EuiFormRow
           label={i18n.translate(
             'xpack.ml.dataframe.analytics.create.numTopFeatureImportanceValuesLabel',
@@ -261,7 +264,7 @@ export const AdvancedStepForm: FC<CreateAnalyticsStepProps> = ({
           />
         </EuiFormRow>
       </EuiFlexItem>
-      <EuiFlexItem style={{ minWidth: '30%' }}>
+      <EuiFlexItem>
         <EuiFormRow
           label={i18n.translate('xpack.ml.dataframe.analytics.create.predictionFieldNameLabel', {
             defaultMessage: 'Prediction field name',
@@ -294,11 +297,11 @@ export const AdvancedStepForm: FC<CreateAnalyticsStepProps> = ({
           })}
         </h3>
       </EuiTitle>
-      <EuiFlexGroup wrap>
+      <EuiFlexGrid columns={3}>
         {jobType === ANALYSIS_CONFIG_TYPE.OUTLIER_DETECTION && outlierDetectionAdvancedConfig}
         {isRegOrClassJob && regAndClassAdvancedConfig}
         {jobType === ANALYSIS_CONFIG_TYPE.CLASSIFICATION && (
-          <EuiFlexItem style={{ minWidth: '30%' }}>
+          <EuiFlexItem>
             <EuiFormRow
               label={i18n.translate('xpack.ml.dataframe.analytics.create.numTopClassesLabel', {
                 defaultMessage: 'Top classes',
@@ -332,7 +335,7 @@ export const AdvancedStepForm: FC<CreateAnalyticsStepProps> = ({
             </EuiFormRow>
           </EuiFlexItem>
         )}
-        <EuiFlexItem style={{ width: '30%', minWidth: '30%' }}>
+        <EuiFlexItem>
           <EuiFormRow
             label={i18n.translate('xpack.ml.dataframe.analytics.create.modelMemoryLimitLabel', {
               defaultMessage: 'Model memory limit',
@@ -361,7 +364,43 @@ export const AdvancedStepForm: FC<CreateAnalyticsStepProps> = ({
             />
           </EuiFormRow>
         </EuiFlexItem>
-      </EuiFlexGroup>
+        <EuiFlexItem>
+          <EuiFormRow
+            label={i18n.translate('xpack.ml.dataframe.analytics.create.maxNumThreadsLabel', {
+              defaultMessage: 'Maximum number of threads',
+            })}
+            helpText={i18n.translate('xpack.ml.dataframe.analytics.create.maxNumThreadsHelpText', {
+              defaultMessage:
+                'The maximum number of threads to be used by the analysis. The default value is 1',
+            })}
+            isInvalid={maxNumThreads === 0}
+            error={
+              maxNumThreads === 0 &&
+              i18n.translate('xpack.ml.dataframe.analytics.create.maxNumThreadsError', {
+                defaultMessage: 'The minimum value is 1.',
+              })
+            }
+          >
+            <EuiFieldNumber
+              aria-label={i18n.translate(
+                'xpack.ml.dataframe.analytics.create.maxNumThreadsInputAriaLabel',
+                {
+                  defaultMessage: 'The maximum number of threads to be used by the analysis.',
+                }
+              )}
+              data-test-subj="mlAnalyticsCreateJobWizardMaxNumThreadsInput"
+              min={1}
+              onChange={(e) =>
+                setFormState({
+                  maxNumThreads: e.target.value === '' ? undefined : +e.target.value,
+                })
+              }
+              step={1}
+              value={getNumberValue(maxNumThreads)}
+            />
+          </EuiFormRow>
+        </EuiFlexItem>
+      </EuiFlexGrid>
       <EuiSpacer />
       <EuiAccordion
         id="hyper-parameters"
@@ -377,7 +416,7 @@ export const AdvancedStepForm: FC<CreateAnalyticsStepProps> = ({
         initialIsOpen={false}
         data-test-subj="mlAnalyticsCreateJobWizardHyperParametersSection"
       >
-        <EuiFlexGroup wrap>
+        <EuiFlexGrid columns={3}>
           {jobType === ANALYSIS_CONFIG_TYPE.OUTLIER_DETECTION && (
             <OutlierHyperParameters
               actions={actions}
@@ -392,7 +431,7 @@ export const AdvancedStepForm: FC<CreateAnalyticsStepProps> = ({
               advancedParamErrors={advancedParamErrors}
             />
           )}
-        </EuiFlexGroup>
+        </EuiFlexGrid>
       </EuiAccordion>
       <EuiSpacer />
       <ContinueButton

diff --git a/...ta_frame_analytics/pages/analytics_creation/components/advanced_step/hyper_parameters.tsx b/...ta_frame_analytics/pages/analytics_creation/components/advanced_step/hyper_parameters.tsx
@@ -24,7 +24,7 @@ export const HyperParameters: FC<Props> = ({ actions, state, advancedParamErrors
 
   return (
     <Fragment>
-      <EuiFlexItem style={{ minWidth: '30%' }}>
+      <EuiFlexItem>
         <EuiFormRow
           label={i18n.translate('xpack.ml.dataframe.analytics.create.lambdaLabel', {
             defaultMessage: 'Lambda',
@@ -51,7 +51,7 @@ export const HyperParameters: FC<Props> = ({ actions, state, advancedParamErrors
           />
         </EuiFormRow>
       </EuiFlexItem>
-      <EuiFlexItem style={{ minWidth: '30%' }}>
+      <EuiFlexItem>
         <EuiFormRow
           label={i18n.translate('xpack.ml.dataframe.analytics.create.maxTreesLabel', {
             defaultMessage: 'Max trees',
@@ -81,7 +81,7 @@ export const HyperParameters: FC<Props> = ({ actions, state, advancedParamErrors
           />
         </EuiFormRow>
       </EuiFlexItem>
-      <EuiFlexItem style={{ minWidth: '30%' }}>
+      <EuiFlexItem>
         <EuiFormRow
           label={i18n.translate('xpack.ml.dataframe.analytics.create.gammaLabel', {
             defaultMessage: 'Gamma',
@@ -108,7 +108,7 @@ export const HyperParameters: FC<Props> = ({ actions, state, advancedParamErrors
           />
         </EuiFormRow>
       </EuiFlexItem>
-      <EuiFlexItem style={{ minWidth: '30%' }}>
+      <EuiFlexItem>
         <EuiFormRow
           label={i18n.translate('xpack.ml.dataframe.analytics.create.etaLabel', {
             defaultMessage: 'Eta',
@@ -134,7 +134,7 @@ export const HyperParameters: FC<Props> = ({ actions, state, advancedParamErrors
           />
         </EuiFormRow>
       </EuiFlexItem>
-      <EuiFlexItem style={{ minWidth: '30%' }}>
+      <EuiFlexItem>
         <EuiFormRow
           label={i18n.translate('xpack.ml.dataframe.analytics.create.featureBagFractionLabel', {
             defaultMessage: 'Feature bag fraction',
@@ -172,7 +172,7 @@ export const HyperParameters: FC<Props> = ({ actions, state, advancedParamErrors
           />
         </EuiFormRow>
       </EuiFlexItem>
-      <EuiFlexItem style={{ minWidth: '30%' }}>
+      <EuiFlexItem>
         <EuiFormRow
           label={i18n.translate('xpack.ml.dataframe.analytics.create.randomizeSeedLabel', {
             defaultMessage: 'Randomize seed',

diff --git a/..._analytics/pages/analytics_creation/components/advanced_step/outlier_hyper_parameters.tsx b/..._analytics/pages/analytics_creation/components/advanced_step/outlier_hyper_parameters.tsx
@@ -22,7 +22,7 @@ export const OutlierHyperParameters: FC<Props> = ({ actions, state, advancedPara
 
   return (
     <Fragment>
-      <EuiFlexItem style={{ minWidth: '30%' }}>
+      <EuiFlexItem>
         <EuiFormRow
           label={i18n.translate('xpack.ml.dataframe.analytics.create.methodLabel', {
             defaultMessage: 'Method',
@@ -48,7 +48,7 @@ export const OutlierHyperParameters: FC<Props> = ({ actions, state, advancedPara
           />
         </EuiFormRow>
       </EuiFlexItem>
-      <EuiFlexItem style={{ minWidth: '30%' }}>
+      <EuiFlexItem>
         <EuiFormRow
           label={i18n.translate('xpack.ml.dataframe.analytics.create.nNeighborsLabel', {
             defaultMessage: 'N neighbors',
@@ -78,7 +78,7 @@ export const OutlierHyperParameters: FC<Props> = ({ actions, state, advancedPara
           />
         </EuiFormRow>
       </EuiFlexItem>
-      <EuiFlexItem style={{ minWidth: '30%' }}>
+      <EuiFlexItem>
         <EuiFormRow
           label={i18n.translate('xpack.ml.dataframe.analytics.create.outlierFractionLabel', {
             defaultMessage: 'Outlier fraction',
@@ -109,7 +109,7 @@ export const OutlierHyperParameters: FC<Props> = ({ actions, state, advancedPara
           />
         </EuiFormRow>
       </EuiFlexItem>
-      <EuiFlexItem style={{ minWidth: '30%' }}>
+      <EuiFlexItem>
         <EuiFormRow
           label={i18n.translate('xpack.ml.dataframe.analytics.create.standardizationEnabledLabel', {
             defaultMessage: 'Standardization enabled',

diff --git a/.../data_frame_analytics/pages/analytics_management/components/action_clone/clone_button.tsx b/.../data_frame_analytics/pages/analytics_management/components/action_clone/clone_button.tsx
@@ -255,6 +255,10 @@ const getAnalyticsJobMeta = (config: CloneDataFrameAnalyticsConfig): AnalyticsJo
     optional: true,
     formKey: 'modelMemoryLimit',
   },
+  max_num_threads: {
+    optional: true,
+    formKey: 'maxNumThreads',
+  },
 });
 
 /**

diff --git a/..._frame_analytics/pages/analytics_management/components/action_edit/edit_button_flyout.tsx b/..._frame_analytics/pages/analytics_management/components/action_edit/edit_button_flyout.tsx
@@ -11,6 +11,7 @@ import { i18n } from '@kbn/i18n';
 import {
   EuiButton,
   EuiButtonEmpty,
+  EuiFieldNumber,
   EuiFieldText,
   EuiFlexGroup,
   EuiFlexItem,
@@ -52,14 +53,15 @@ export const EditButtonFlyout: FC<Required<EditAction>> = ({ closeFlyout, item }
   const [description, setDescription] = useState<string>(config.description || '');
   const [modelMemoryLimit, setModelMemoryLimit] = useState<string>(config.model_memory_limit);
   const [mmlValidationError, setMmlValidationError] = useState<string | undefined>();
+  const [maxNumThreads, setMaxNumThreads] = useState<number | undefined>(config.max_num_threads);
 
   const {
     services: { notifications },
   } = useMlKibana();
   const { refresh } = useRefreshAnalyticsList();
 
   // Disable if mml is not valid
-  const updateButtonDisabled = mmlValidationError !== undefined;
+  const updateButtonDisabled = mmlValidationError !== undefined || maxNumThreads === 0;
 
   useEffect(() => {
     if (mmLValidator === undefined) {
@@ -93,7 +95,8 @@ export const EditButtonFlyout: FC<Required<EditAction>> = ({ closeFlyout, item }
         allow_lazy_start: allowLazyStart,
         description,
       },
-      modelMemoryLimit && { model_memory_limit: modelMemoryLimit }
+      modelMemoryLimit && { model_memory_limit: modelMemoryLimit },
+      maxNumThreads && { max_num_threads: maxNumThreads }
     );
 
     try {
@@ -210,7 +213,7 @@ export const EditButtonFlyout: FC<Required<EditAction>> = ({ closeFlyout, item }
               helpText={
                 state !== DATA_FRAME_TASK_STATE.STOPPED &&
                 i18n.translate('xpack.ml.dataframe.analyticsList.editFlyout.modelMemoryHelpText', {
-                  defaultMessage: 'Model memory limit cannot be edited while the job is running.',
+                  defaultMessage: 'Model memory limit cannot be edited until the job has stopped.',
                 })
               }
               label={i18n.translate(
@@ -236,6 +239,49 @@ export const EditButtonFlyout: FC<Required<EditAction>> = ({ closeFlyout, item }
                 )}
               />
             </EuiFormRow>
+            <EuiFormRow
+              helpText={
+                state !== DATA_FRAME_TASK_STATE.STOPPED &&
+                i18n.translate(
+                  'xpack.ml.dataframe.analyticsList.editFlyout.maxNumThreadsHelpText',
+                  {
+                    defaultMessage:
+                      'Maximum number of threads cannot be edited until the job has stopped.',
+                  }
+                )
+              }
+              label={i18n.translate(
+                'xpack.ml.dataframe.analyticsList.editFlyout.maxNumThreadsLabel',
+                {
+                  defaultMessage: 'Maximum number of threads',
+                }
+              )}
+              isInvalid={maxNumThreads === 0}
+              error={
+                maxNumThreads === 0 &&
+                i18n.translate('xpack.ml.dataframe.analyticsList.editFlyout.maxNumThreadsError', {
+                  defaultMessage: 'The minimum value is 1.',
+                })
+              }
+            >
+              <EuiFieldNumber
+                aria-label={i18n.translate(
+                  'xpack.ml.dataframe.analyticsList.editFlyout.maxNumThreadsAriaLabel',
+                  {
+                    defaultMessage:
+                      'Update the maximum number of threads to be used by the analysis.',
+                  }
+                )}
+                data-test-subj="mlAnalyticsEditFlyoutMaxNumThreadsLimitInput"
+                onChange={(e) =>
+                  setMaxNumThreads(e.target.value === '' ? undefined : +e.target.value)
+                }
+                step={1}
+                min={1}
+                readOnly={state !== DATA_FRAME_TASK_STATE.STOPPED}
+                value={maxNumThreads}
+              />
+            </EuiFormRow>
           </EuiForm>
         </EuiFlyoutBody>
         <EuiFlyoutFooter>