import { IFairnessProps, PredictionType, PredictionTypes } from "./IFairnessProps"; import React from "react"; import { IFairnessContext, IFairnessModelMetadata } from "./IFairnessContext"; import { localization } from "./Localization/localization"; import _ from "lodash"; import { Pivot, PivotItem } from "office-ui-fabric-react/lib/Pivot"; import { Stack, StackItem } from "office-ui-fabric-react/lib/Stack"; import { SelectionContext, ICategoricalRange, IModelMetadata, ModelMetadata, RangeTypes } from "mlchartlib"; import { AccuracyOptions, IAccuracyOption } from "./AccuracyMetrics"; import { WizardReport } from "./WizardReport"; import { AccuracyTab } from "./Controls/AccuracyTab"; import { ParityTab } from "./Controls/ParityTab"; import { ParityOptions, IParityOption } from "./ParityMetrics"; import { MetricsCache } from "./MetricsCache"; import { ModelComparisonChart } from "./Controls/ModelComparisonChart"; import { FeatureTab } from "./Controls/FeatureTab"; import { IBinnedResponse } from "./IBinnedResponse"; import { Text } from "office-ui-fabric-react/lib/Text"; import { IntroTab } from "./Controls/IntroTab"; import { number } from "prop-types"; import { mergeStyleSets } from "@uifabric/styling"; import { BinnedResponseBuilder } from "./BinnedResponseBuilder"; export interface IAccuracyPickerProps { accuracyOptions: IAccuracyOption[]; selectedAccuracyKey: string; onAccuracyChange: (newKey: string) => void; } export interface IParityPickerProps { parityOptions: IAccuracyOption[]; selectedParityKey: string; onParityChange: (newKey: string) => void; } export interface IFeatureBinPickerProps { featureBins: IBinnedResponse[]; selectedBinIndex: number; onBinChange: (index: number) => void; } export interface IWizardState { activeTabKey: string; selectedModelId?: number; dashboardContext: IFairnessContext; accuracyMetrics: IAccuracyOption[]; parityMetrics: IAccuracyOption[]; selectedAccuracyKey: string; selectedParityKey: string; featureBins: IBinnedResponse[]; selectedBinIndex: number; metricCache: MetricsCache; } const introTabKey = "introTab"; const featureBinTabKey = "featureBinTab"; const accuracyTabKey = "accuracyTab"; const disparityTabKey = "disparityTab"; const reportTabKey = "reportTab" const flights = { skipDisparity: true } export class FairnessWizard extends React.PureComponent { private static buildInitialFairnessContext(props: IFairnessProps): IFairnessContext { const modelNames = (!!props.modelNames && props.modelNames.length === props.predictedY.length) ? props.modelNames : props.predictedY.map((unused, modelIndex) => `Model ${modelIndex}`) return { dataset: props.testData, trueY: props.trueY, predictions: props.predictedY, binVector: [], groupNames: [], modelMetadata: FairnessWizard.buildModelMetadata(props), modelNames }; } private static getClassLength(props: IFairnessProps): number { return _.uniq(props.trueY).length; } private static buildModelMetadata(props: IFairnessProps): IFairnessModelMetadata { let featureNames = props.dataSummary.featureNames; if (!featureNames) { let featureLength = 0; if (props.testData && props.testData[0] !== undefined) { featureLength = props.testData[0].length; } featureNames = featureLength === 1 ? [localization.defaultSingleFeatureName] : ModelMetadata.buildIndexedNames(featureLength, localization.defaultFeatureNames); } const classNames = props.dataSummary.classNames || ModelMetadata.buildIndexedNames(FairnessWizard.getClassLength(props), localization.defaultClassNames); const featureIsCategorical = ModelMetadata.buildIsCategorical(featureNames.length, props.testData, props.dataSummary.categoricalMap); const featureRanges = ModelMetadata.buildFeatureRanges(props.testData, featureIsCategorical, props.dataSummary.categoricalMap); const predictionType = FairnessWizard.determinePredictionType(props.trueY, props.predictedY, props.predictionType); return { featureNames, featureNamesAbridged: featureNames, classNames, featureIsCategorical, featureRanges, predictionType }; } private static determinePredictionType(trueY: number[], predictedYs: number[][], specifiedType?: PredictionType): PredictionType { if (specifiedType === PredictionTypes.binaryClassification || specifiedType === PredictionTypes.probability || specifiedType === PredictionTypes.regression) { return specifiedType; } const predictedIsPossibleProba = predictedYs.every(predictionVector => predictionVector.every(x => x >= 0 && x <= 1)); const trueIsBinary = _.uniq(trueY).length < 3; if (!trueIsBinary) { return PredictionTypes.regression; } if (_.uniq(_.flatten(predictedYs)).length < 3) { return PredictionTypes.binaryClassification; } if (predictedIsPossibleProba) { return PredictionTypes.probability; } return PredictionTypes.regression; } private static readonly classNames = mergeStyleSets({ frame: { minHeight: "800px", minWidth: "800px", fontFamily: `"Segoe UI", "Segoe UI Web (West European)", "Segoe UI", -apple-system, BlinkMacSystemFont, Roboto, "Helvetica Neue", sans-serif` }, thinHeader: { height: "36px", backgroundColor: "#333333", color: "#FFFFFF" }, headerLeft: { fontSize: "15px", lineHeight: "24px", fontWeight: "500", padding: "20px" }, headerRight: { fontSize: "12px", padding: "20px" }, pivot: { flex: 1, display: "flex", flexDirection: "column", backgroundColor: "#F2F2F2", padding: "30px 90px 0 82px" }, body: { flex: 1, display: "flex", flexDirection: "column" }, errorMessage: { padding: "50px", fontSize: "18px" } }); private selections: SelectionContext; constructor(props: IFairnessProps) { super(props); const fairnessContext = FairnessWizard.buildInitialFairnessContext(props); this.selections = new SelectionContext("models", 1); this.selections.subscribe({selectionCallback: (strings: string[]) => { const numbers = strings.map(s => +s); this.setSelectedModel(numbers[0]); }}); const featureBins = this.buildFeatureBins(fairnessContext); if (featureBins.length > 0) { fairnessContext.binVector = this.generateBinVectorForBin(featureBins[0], fairnessContext.dataset); fairnessContext.groupNames = featureBins[0].labelArray; } let accuracyMetrics = fairnessContext.modelMetadata.predictionType === PredictionTypes.binaryClassification ? this.props.supportedBinaryClassificationAccuracyKeys.map(key => AccuracyOptions[key]) : (fairnessContext.modelMetadata.predictionType === PredictionTypes.regression ? this.props.supportedRegressionAccuracyKeys.map(key => AccuracyOptions[key]) : this.props.supportedProbabilityAccuracyKeys.map(key => AccuracyOptions[key])) accuracyMetrics = accuracyMetrics.filter(metric => !!metric); this.state = { accuracyMetrics, selectedAccuracyKey: accuracyMetrics[0].key, parityMetrics: accuracyMetrics, selectedParityKey: accuracyMetrics[0].key, dashboardContext: fairnessContext, activeTabKey: introTabKey, featureBins, selectedBinIndex: 0, selectedModelId: this.props.predictedY.length === 1 ? 0 : undefined, metricCache: new MetricsCache( featureBins.length, this.props.predictedY.length, this.props.requestMetrics) }; } public render(): React.ReactNode { const accuracyPickerProps = { accuracyOptions: this.state.accuracyMetrics, selectedAccuracyKey: this.state.selectedAccuracyKey, onAccuracyChange: this.setAccuracyKey }; const parityPickerProps = { parityOptions: this.state.parityMetrics, selectedParityKey: this.state.selectedParityKey, onParityChange: this.setParityKey }; const featureBinPickerProps = { featureBins: this.state.featureBins, selectedBinIndex: this.state.selectedBinIndex, onBinChange: this.setBinIndex }; if (this.state.featureBins.length === 0) { return (
{localization.Header.title}
{/*
{localization.Header.documentation}
*/}
{localization.errorOnInputs}
); } return (
{localization.Header.title}
{/*
{localization.Header.documentation}
*/}
{(this.state.activeTabKey === introTabKey) && } {(this.state.activeTabKey === featureBinTabKey || this.state.activeTabKey === accuracyTabKey || this.state.activeTabKey === disparityTabKey ) && !!x)} onNext={this.setTab.bind(this, accuracyTabKey)} saveBin={this.saveBin} /> {(flights.skipDisparity === false) && ( )} } {(this.state.activeTabKey === reportTabKey && this.state.selectedModelId !== undefined) && } {(this.state.activeTabKey === reportTabKey && this.state.selectedModelId === undefined) && }
); } private readonly setTab = (key: string) => { this.setState({ activeTabKey: key}); } private readonly setSelectedModel = (index: number) => { this.setState({selectedModelId: index}); } private readonly setAccuracyKey = (key: string) => { const value: Partial = {selectedAccuracyKey: key}; if (flights.skipDisparity) { value.selectedParityKey = key; } this.setState(value as IWizardState); } private readonly setParityKey = (key: string) => { this.setState({selectedParityKey: key}); } private readonly setBinIndex = (index: number) => { this.binningSet(this.state.featureBins[index]) } private readonly handleTabClick = (item: PivotItem) => { this.setState({activeTabKey: item.props.itemKey}); } private readonly binningSet = (value: IBinnedResponse) => { if (!value || value.hasError || value.array.length === 0) { return; } const newContext = _.cloneDeep(this.state.dashboardContext); newContext.binVector = this.generateBinVectorForBin(value, this.state.dashboardContext.dataset); newContext.groupNames = value.labelArray; this.setState({dashboardContext: newContext, selectedBinIndex: value.featureIndex}); } private generateBinVectorForBin(value: IBinnedResponse, dataset: any[][]): number[] { return dataset.map((row, rowIndex) => { const featureValue = row[value.featureIndex]; if (value.rangeType === RangeTypes.categorical) { // this handles categorical, as well as integers when user requests to treat as categorical return value.array.indexOf(featureValue); } else { return value.array.findIndex((upperLimit, groupIndex) => { return upperLimit >= featureValue; }); } }); } private readonly buildFeatureBins = (fairnessContext: IFairnessContext): IBinnedResponse[] => { return fairnessContext.modelMetadata.featureNames.map((name, index) => { return BinnedResponseBuilder.buildDefaultBin(fairnessContext.modelMetadata.featureRanges[index], index, fairnessContext.dataset); }); } private readonly saveBin = (bin: IBinnedResponse): void => { this.state.featureBins[bin.featureIndex] = bin; this.state.metricCache.clearCache(bin.featureIndex); this.binningSet(bin); } private readonly onMetricError = (error: any): void => { this.setState({activeTabKey: accuracyTabKey}); } }