Skip to content

Commit

Permalink
[ML] Rename DataFrameAnalyticsType -> DataFrameAnalysisConfigType
Browse files Browse the repository at this point in the history
  • Loading branch information
qn895 committed Sep 15, 2020
1 parent 29d8674 commit d3edff7
Show file tree
Hide file tree
Showing 17 changed files with 37 additions and 37 deletions.
2 changes: 1 addition & 1 deletion x-pack/plugins/ml/common/types/data_frame_analytics.ts
Original file line number Diff line number Diff line change
Expand Up @@ -82,4 +82,4 @@ export interface DataFrameAnalyticsConfig {
allow_lazy_start?: boolean;
}

export type DataFrameAnalyticsType = typeof ANALYSIS_CONFIG_TYPE[keyof typeof ANALYSIS_CONFIG_TYPE];
export type DataFrameAnalysisConfigType = typeof ANALYSIS_CONFIG_TYPE[keyof typeof ANALYSIS_CONFIG_TYPE];
6 changes: 3 additions & 3 deletions x-pack/plugins/ml/common/types/ml_url_generator.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
import { RefreshInterval, TimeRange } from '../../../../../src/plugins/data/common/query';
import { JobId } from './anomaly_detection_jobs/job';
import { ML_PAGES } from '../constants/ml_url_generator';
import { DataFrameAnalyticsType } from './data_frame_analytics';
import { DataFrameAnalysisConfigType } from './data_frame_analytics';

type OptionalPageState = object | undefined;

Expand Down Expand Up @@ -163,15 +163,15 @@ export type DataFrameAnalyticsUrlState = MLPageState<
export interface DataFrameAnalyticsExplorationQueryState {
ml: {
jobId: JobId;
analysisType: DataFrameAnalyticsType;
analysisType: DataFrameAnalysisConfigType;
};
}

export type DataFrameAnalyticsExplorationUrlState = MLPageState<
typeof ML_PAGES.DATA_FRAME_ANALYTICS_EXPLORATION,
{
jobId: JobId;
analysisType: DataFrameAnalyticsType;
analysisType: DataFrameAnalysisConfigType;
globalState?: MlCommonGlobalState;
}
>;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ import { UseIndexDataReturnType } from './types';
import { DecisionPathPopover } from './feature_importance/decision_path_popover';
import { TopClasses } from '../../../../common/types/feature_importance';
import { DEFAULT_RESULTS_FIELD } from '../../../../common/constants/data_frame_analytics';
import { DataFrameAnalyticsType } from '../../../../common/types/data_frame_analytics';
import { DataFrameAnalysisConfigType } from '../../../../common/types/data_frame_analytics';

// TODO Fix row hovering + bar highlighting
// import { hoveredRow$ } from './column_chart';
Expand All @@ -45,7 +45,7 @@ export const DataGridTitle: FC<{ title: string }> = ({ title }) => (

interface PropsWithoutHeader extends UseIndexDataReturnType {
baseline?: number;
analysisType?: DataFrameAnalyticsType;
analysisType?: DataFrameAnalysisConfigType;
resultsField?: string;
dataTestSubj: string;
toastNotifications: CoreSetup['notifications']['toasts'];
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,11 @@ import { FeatureImportance, TopClasses } from '../../../../../common/types/featu
import { ANALYSIS_CONFIG_TYPE } from '../../../data_frame_analytics/common';
import { ClassificationDecisionPath } from './decision_path_classification';
import { useMlKibana } from '../../../contexts/kibana';
import { DataFrameAnalyticsType } from '../../../../../common/types/data_frame_analytics';
import { DataFrameAnalysisConfigType } from '../../../../../common/types/data_frame_analytics';

interface DecisionPathPopoverProps {
featureImportance: FeatureImportance[];
analysisType: DataFrameAnalyticsType;
analysisType: DataFrameAnalysisConfigType;
predictionFieldName?: string;
baseline?: number;
predictedValue?: number | string | undefined;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import { SavedSearchQuery } from '../../contexts/ml';
import {
AnalysisConfig,
ClassificationAnalysis,
DataFrameAnalyticsType,
DataFrameAnalysisConfigType,
RegressionAnalysis,
} from '../../../../common/types/data_frame_analytics';
import {
Expand Down Expand Up @@ -430,7 +430,7 @@ interface LoadEvalDataConfig {
predictionFieldName?: string;
searchQuery?: ResultsSearchQuery;
ignoreDefaultQuery?: boolean;
jobType: DataFrameAnalyticsType;
jobType: DataFrameAnalysisConfigType;
requiresKeyword?: boolean;
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import { BASIC_NUMERICAL_TYPES, EXTENDED_NUMERICAL_TYPES } from '../../../../com
import { CATEGORICAL_TYPES } from './form_options_validation';
import { ES_FIELD_TYPES } from '../../../../../../../../../../src/plugins/data/public';
import { newJobCapsService } from '../../../../../services/new_job_capabilities_service';
import { DataFrameAnalyticsType } from '../../../../../../../common/types/data_frame_analytics';
import { DataFrameAnalysisConfigType } from '../../../../../../../common/types/data_frame_analytics';

const containsClassificationFieldsCb = ({ name, type }: Field) =>
!OMIT_FIELDS.includes(name) &&
Expand All @@ -33,13 +33,13 @@ const containsRegressionFieldsCb = ({ name, type }: Field) =>
const containsOutlierFieldsCb = ({ name, type }: Field) =>
!OMIT_FIELDS.includes(name) && name !== EVENT_RATE_FIELD_ID && BASIC_NUMERICAL_TYPES.has(type);

const callbacks: Record<DataFrameAnalyticsType, (f: Field) => boolean> = {
const callbacks: Record<DataFrameAnalysisConfigType, (f: Field) => boolean> = {
[ANALYSIS_CONFIG_TYPE.CLASSIFICATION]: containsClassificationFieldsCb,
[ANALYSIS_CONFIG_TYPE.REGRESSION]: containsRegressionFieldsCb,
[ANALYSIS_CONFIG_TYPE.OUTLIER_DETECTION]: containsOutlierFieldsCb,
};

const messages: Record<DataFrameAnalyticsType, JSX.Element> = {
const messages: Record<DataFrameAnalysisConfigType, JSX.Element> = {
[ANALYSIS_CONFIG_TYPE.CLASSIFICATION]: (
<FormattedMessage
id="xpack.ml.dataframe.analytics.create.sourceObjectClassificationHelpText"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ import { ml } from '../../../../../services/ml_api_service';
import { BackToListPanel } from '../back_to_list_panel';
import { ViewResultsPanel } from '../view_results_panel';
import { ProgressStats } from './progress_stats';
import { DataFrameAnalyticsType } from '../../../../../../../common/types/data_frame_analytics';
import { DataFrameAnalysisConfigType } from '../../../../../../../common/types/data_frame_analytics';

export const PROGRESS_REFRESH_INTERVAL_MS = 1000;

interface Props {
jobId: string;
jobType: DataFrameAnalyticsType;
jobType: DataFrameAnalysisConfigType;
showProgress: boolean;
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ import { i18n } from '@kbn/i18n';
import { useMlUrlGenerator } from '../../../../../contexts/kibana';
import { ML_PAGES } from '../../../../../../../common/constants/ml_url_generator';
import { useNavigateToPath } from '../../../../../contexts/kibana';
import { DataFrameAnalyticsType } from '../../../../../../../common/types/data_frame_analytics';
import { DataFrameAnalysisConfigType } from '../../../../../../../common/types/data_frame_analytics';
interface Props {
jobId: string;
analysisType: DataFrameAnalyticsType;
analysisType: DataFrameAnalysisConfigType;
}

export const ViewResultsPanel: FC<Props> = ({ jobId, analysisType }) => {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ import { IndexPatternPrompt } from '../index_pattern_prompt';

import { useExplorationResults } from './use_exploration_results';
import { useMlKibana } from '../../../../../contexts/kibana';
import { DataFrameAnalyticsType } from '../../../../../../../common/types/data_frame_analytics';
import { DataFrameAnalysisConfigType } from '../../../../../../../common/types/data_frame_analytics';

const showingDocs = i18n.translate(
'xpack.ml.dataframe.analytics.explorationResults.documentsShownHelpText',
Expand Down Expand Up @@ -195,7 +195,7 @@ export const ExplorationResultsTable: FC<Props> = React.memo(
{...classificationData}
dataTestSubj="mlExplorationDataGrid"
toastNotifications={getToastNotifications()}
analysisType={(analysisType as unknown) as DataFrameAnalyticsType}
analysisType={(analysisType as unknown) as DataFrameAnalysisConfigType}
/>
</EuiFlexItem>
</EuiFlexGroup>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,11 @@ import { RegressionExploration } from './components/regression_exploration';
import { ClassificationExploration } from './components/classification_exploration';

import { ANALYSIS_CONFIG_TYPE } from '../../../../../common/constants/data_frame_analytics';
import { DataFrameAnalyticsType } from '../../../../../common/types/data_frame_analytics';
import { DataFrameAnalysisConfigType } from '../../../../../common/types/data_frame_analytics';

export const Page: FC<{
jobId: string;
analysisType: DataFrameAnalyticsType;
analysisType: DataFrameAnalysisConfigType;
}> = ({ jobId, analysisType }) => (
<Fragment>
<NavigationMenu tabId="data_frame_analytics" />
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,15 @@ import { DataFrameAnalyticsListAction, DataFrameAnalyticsListRow } from '../anal

import { getViewLinkStatus } from './get_view_link_status';
import { viewActionButtonText, ViewButton } from './view_button';
import { DataFrameAnalyticsType } from '../../../../../../../common/types/data_frame_analytics';
import { DataFrameAnalysisConfigType } from '../../../../../../../common/types/data_frame_analytics';
import { ML_PAGES } from '../../../../../../../common/constants/ml_url_generator';

export type ViewAction = ReturnType<typeof useViewAction>;
export const useViewAction = () => {
const mlUrlGenerator = useMlUrlGenerator();
const navigateToPath = useNavigateToPath();

const redirectToTab = async (jobId: string, analysisType: DataFrameAnalyticsType) => {
const redirectToTab = async (jobId: string, analysisType: DataFrameAnalysisConfigType) => {
const path = await mlUrlGenerator.createUrl({
page: ML_PAGES.DATA_FRAME_ANALYTICS_EXPLORATION,
pageState: { jobId, analysisType },
Expand All @@ -31,7 +31,7 @@ export const useViewAction = () => {
};

const clickHandler = useCallback((item: DataFrameAnalyticsListRow) => {
const analysisType = getAnalysisType(item.config.analysis) as DataFrameAnalyticsType;
const analysisType = getAnalysisType(item.config.analysis) as DataFrameAnalysisConfigType;
redirectToTab(item.id, analysisType);
}, []);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { DATA_FRAME_TASK_STATE } from './data_frame_task_state';
export { DATA_FRAME_TASK_STATE };

import { DataFrameAnalyticsId, DataFrameAnalyticsConfig } from '../../../../common';
import { DataFrameAnalyticsType } from '../../../../../../../common/types/data_frame_analytics';
import { DataFrameAnalysisConfigType } from '../../../../../../../common/types/data_frame_analytics';

export enum DATA_FRAME_MODE {
BATCH = 'batch',
Expand Down Expand Up @@ -108,7 +108,7 @@ export interface DataFrameAnalyticsListRow {
checkpointing: object;
config: DataFrameAnalyticsConfig;
id: DataFrameAnalyticsId;
job_type: DataFrameAnalyticsType;
job_type: DataFrameAnalysisConfigType;
mode: string;
state: DataFrameAnalyticsStats['state'];
stats: DataFrameAnalyticsStats;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ import {
import { useTableSettings } from '../analytics_list/use_table_settings';
import { filterAnalyticsModels, AnalyticsSearchBar } from '../analytics_search_bar';
import { ML_PAGES } from '../../../../../../../common/constants/ml_url_generator';
import { DataFrameAnalyticsType } from '../../../../../../../common/types/data_frame_analytics';
import { DataFrameAnalysisConfigType } from '../../../../../../../common/types/data_frame_analytics';

type Stats = Omit<TrainedModelStat, 'model_id'>;

Expand Down Expand Up @@ -288,7 +288,7 @@ export const ModelsList: FC = () => {
jobId: item.metadata?.analytics_config.id as string,
analysisType: Object.keys(
item.metadata?.analytics_config.analysis
)[0] as DataFrameAnalyticsType,
)[0] as DataFrameAnalysisConfigType,
},
});

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ import { CloneDataFrameAnalyticsConfig } from '../../components/action_clone';
import {
DataFrameAnalyticsConfig,
DataFrameAnalyticsId,
DataFrameAnalyticsType,
DataFrameAnalysisConfigType,
} from '../../../../../../../common/types/data_frame_analytics';
import { ANALYSIS_CONFIG_TYPE } from '../../../../../../../common/constants/data_frame_analytics';
export enum DEFAULT_MODEL_MEMORY_LIMIT {
Expand All @@ -29,7 +29,7 @@ export const UNSET_CONFIG_ITEM = '--';
export type EsIndexName = string;
export type DependentVariable = string;
export type IndexPatternTitle = string;
export type AnalyticsJobType = DataFrameAnalyticsType | undefined;
export type AnalyticsJobType = DataFrameAnalysisConfigType | undefined;
type IndexPatternId = string;
export type SourceIndexMap = Record<
IndexPatternTitle,
Expand Down Expand Up @@ -291,7 +291,7 @@ export function getFormStateFromJobConfig(
analyticsJobConfig: Readonly<CloneDataFrameAnalyticsConfig>,
isClone: boolean = true
): Partial<State['form']> {
const jobType = Object.keys(analyticsJobConfig.analysis)[0] as DataFrameAnalyticsType;
const jobType = Object.keys(analyticsJobConfig.analysis)[0] as DataFrameAnalysisConfigType;

const resultState: Partial<State['form']> = {
jobType,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ import {
isDataFrameAnalyticsStopped,
} from '../../components/analytics_list/common';
import { AnalyticStatsBarStats } from '../../../../../components/stats_bar';
import { DataFrameAnalyticsType } from '../../../../../../../common/types/data_frame_analytics';
import { DataFrameAnalysisConfigType } from '../../../../../../../common/types/data_frame_analytics';

export const isGetDataFrameAnalyticsStatsResponseOk = (
arg: any
Expand Down Expand Up @@ -140,7 +140,7 @@ export const getAnalyticsFactory = (
checkpointing: {},
config,
id: config.id,
job_type: Object.keys(config.analysis)[0] as DataFrameAnalyticsType,
job_type: Object.keys(config.analysis)[0] as DataFrameAnalysisConfigType,
mode: DATA_FRAME_MODE.BATCH,
state: stats.state,
stats,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import { getAnalysisType } from '../../../data_frame_analytics/common/analytics'
import { DataFrameAnalyticsListRow } from '../../../data_frame_analytics/pages/analytics_management/components/analytics_list/common';
import { getViewLinkStatus } from '../../../data_frame_analytics/pages/analytics_management/components/action_view/get_view_link_status';
import { ML_PAGES } from '../../../../../common/constants/ml_url_generator';
import { DataFrameAnalyticsType } from '../../../../../common/types/data_frame_analytics';
import { DataFrameAnalysisConfigType } from '../../../../../common/types/data_frame_analytics';

interface Props {
item: DataFrameAnalyticsListRow;
Expand All @@ -37,7 +37,7 @@ export const ViewLink: FC<Props> = ({ item }) => {
page: ML_PAGES.DATA_FRAME_ANALYTICS_EXPLORATION,
pageState: {
jobId: item.id,
analysisType: analysisType as DataFrameAnalyticsType,
analysisType: analysisType as DataFrameAnalysisConfigType,
},
excludeBasePath: true,
});
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import { basicResolvers } from '../../resolvers';
import { Page } from '../../../data_frame_analytics/pages/analytics_exploration';
import { getBreadcrumbWithUrlForApp } from '../../breadcrumbs';
import { ML_PAGES } from '../../../../../common/constants/ml_url_generator';
import { DataFrameAnalyticsType } from '../../../../../common/types/data_frame_analytics';
import { DataFrameAnalysisConfigType } from '../../../../../common/types/data_frame_analytics';

export const analyticsJobExplorationRouteFactory = (
navigateToPath: NavigateToPath,
Expand Down Expand Up @@ -66,7 +66,7 @@ const PageWrapper: FC<PageProps> = ({ location, deps }) => {
return <></>;
}
const jobId: string = globalState.ml.jobId;
const analysisType: DataFrameAnalyticsType = globalState.ml.analysisType;
const analysisType: DataFrameAnalysisConfigType = globalState.ml.analysisType;

return (
<PageLoader context={context}>
Expand Down

0 comments on commit d3edff7

Please sign in to comment.