Skip to content
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

[Telemetry] Add button click event trackers for new model overview, data explorer, feature importances, counterfactual and causal #1574

Merged
merged 31 commits into from
Jul 22, 2022

Conversation

tongyu-microsoft
Copy link
Contributor

@tongyu-microsoft tongyu-microsoft commented Jul 21, 2022

This PR adds button click trackers for new model overview, data explorer, feature importances, counterfactual and causal components. We will use telemetryHook to pass event names to AzureML studio UI, so that we can keep tracking of what buttons users click on.

Description

Here is list of events that we will be tracking:
// Core
NewAxisConfigSelected = "NewAxisConfigSelected",
// Cohort
NewCohortAdded = "NewCohortAdded",
// Main menu
MainMenuCohortSettingsClick = "MainMenuCohortSettingsClick",
MainMenuDashboardConfigurationClick = "MainMenuDashboardConfigurationClick",
MainMenuSwitchCohortClick = "MainMenuSwitchCohortClick",
MainMenuNewCohortClick = "MainMenuNewCohortClick",
// Error analysis
ErrorAnalysisTreeMapTabClick = "ErrorAnalysisTreeMapTabClick",
ErrorAnalysisTreeMapFeatureListClick = "ErrorAnalysisTreeMapFeatureListClick",
ErrorAnalysisTreeMapClearSelection = "ErrorAnalysisTreeMapClearSelection",
ErrorAnalysisTreeMapSaveAsNewCohortClick = "ErrorAnalysisTreeMapSaveAsNewCohortClick",
ErrorAnalysisTreeMapCohortSaved = "ErrorAnalysisTreeMapCohortSaved",
ErrorAnalysisHeatMapTabClick = "ErrorAnalysisHeatMapTabClick",
ErrorAnalysisHeatMapQuantileBinningClick = "ErrorAnalysisHeatMapQuantileBinningClick",
ErrorAnalysisNewMetricSelected = "ErrorAnalysisNewMetricSelected",
// Model overview
ModelOverviewDatasetCohortsTabClick = "ModelOverviewDatasetCohortsTabClick",
ModelOverviewFeatureCohortsTabClick = "ModelOverviewFeatureCohortsTabClick",
ModelOverviewMetricsConfigurationClick = "ModelOverviewMetricsConfigurationClick",
ModelOverviewFeatureConfigurationClick = "ModelOverviewFeatureConfigurationClick",
ModelOverviewMetricsSelectionUpdated = "ModelOverviewMetricsSelectionUpdated",
ModelOverviewShowHeatmapToggleUpdated = "ModelOverviewShowHeatmapToggleUpdated",
ModelOverviewSplineChartToggleUpdated = "ModelOverviewSplineChartToggleUpdated",
// Dataset explorer
DatasetExplorerNewCohortSelected = "DatasetExplorerNewCohortSelected",
DatasetExplorerNewChartTypeSelected = "DatasetExplorerNewChartTypeSelected",
// Feature importances
AggregateFeatureImportanceTabClick = "AggregateFeatureImportanceTabClick",
IndividualFeatureImportanceTabClick = "IndividualFeatureImportanceTabClick",
AggregateFeatureImportanceNewDependenceSelected = "AggregateFeatureImportanceNewDependenceSelected",
IndividualFeatureImportanceSelectedDatapointsUpdated = "IndividualFeatureImportanceSelectedDatapointsUpdated",
IndividualFeatureImportanceFeatureImportancePlotClick = "IndividualFeatureImportanceFeatureImportancePlotClick",
IndividualFeatureImportanceICEPlotClick = "IndividualFeatureImportanceICEPlotClick",
FeatureImportancesWhatDoValuesMeanCalloutClick = "FeatureImportancesWhatDoValuesMeanCalloutClick",
FeatureImportancesCrossClassWeightsCalloutClick = "FeatureImportancesCrossClassWeightsCalloutClick",
FeatureImportancesHowToReadChartCalloutClick = "FeatureImportancesHowToReadChartCalloutClick",
// Counterfactual
CounterfactualNewDatapointSelectedFromChart = "CounterfactualNewDatapointSelectedFromChart",
CounterfactualNewDatapointSelectedFromDropdown = "CounterfactualNewDatapointSelectedFromDropdown",
CounterfactualCreateWhatIfCounterfactualClick = "CounterfactualCreateWhatIfCounterfactualClick",
CounterfactualSaveAsNewDatapointClick = "CounterfactualSaveAsNewDatapointClick",
CounterfactualListSetValueClick = "CounterfactualListSetValueClick",
// Causal analysis
AggregateCausalTabClick = "AggregateCausalTabClick",
AggregateCausalWhyIncludeConfoundingFeaturesCalloutClick = "AggregateCausalWhyIncludeConfoundingFeaturesCalloutClick",
IndividualCausalTabClick = "IndividualCausalTabClick",
IndividualCausalWhyIncludeConfoundingFeaturesCalloutClick = "IndividualCausalWhyIncludeConfoundingFeaturesCalloutClick",
IndividualCausalSelectedDatapointUpdatedFromChart = "IndividualCausalSelectedDatapointUpdatedFromChart",
IndividualCausalSelectedDatapointUpdatedFromDropdown = "IndividualCausalSelectedDatapointUpdatedFromDropdown",
CasualTreatmentPolicyTabClick = "CasualTreatmentPolicyTabClick",
CasualTreatmentPolicyNewTreatmentFeatureSelected = "CasualTreatmentPolicyNewTreatmentFeatureSelected"

Checklist

  • I have added screenshots above for all UI changes.
  • I have added e2e tests for all UI changes.
  • Documentation was updated if it was needed.

@tongyu-microsoft tongyu-microsoft changed the title [Telemetry] Add button click event trackers for new model overview component [Telemetry] Add button click event trackers for new model overview, data explorer, feature importances Jul 21, 2022
@tongyu-microsoft tongyu-microsoft changed the title [Telemetry] Add button click event trackers for new model overview, data explorer, feature importances [Telemetry] Add button click event trackers for new model overview, data explorer, feature importances, counterfactual and causal Jul 21, 2022
@codecov-commenter
Copy link

codecov-commenter commented Jul 21, 2022

Codecov Report

Merging #1574 (80f3a4d) into main (d4c2d4e) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #1574   +/-   ##
=======================================
  Coverage   88.04%   88.04%           
=======================================
  Files         109      109           
  Lines        5295     5295           
=======================================
  Hits         4662     4662           
  Misses        633      633           
Flag Coverage Δ
unittests 88.04% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d4c2d4e...80f3a4d. Read the comment docs.

@tongyu-microsoft tongyu-microsoft requested a review from gaugup as a code owner July 21, 2022 23:37
1 similar comment
2 similar comments
@tongyu-microsoft tongyu-microsoft enabled auto-merge (squash) July 22, 2022 18:48
@tongyu-microsoft tongyu-microsoft merged commit 54179a0 into main Jul 22, 2022
@tongyu-microsoft tongyu-microsoft deleted the tongy/addButtonClickLogPart2 branch July 22, 2022 21:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants