ModelStudio Versions Save

📍 Interactive Studio for Explanatory Model Analysis

v3.1.2

1 year ago
  • added a new parameter to modelStudio(): open_plots = c("fi"), which is a vector listing plots to be initially opened (and on which positions) (#112)
  • fixed future warning with DALEX::loss_default() since DALEX >=2.5.0

v3.1.0

2 years ago
  • changed y-axis variable labels in SV to the same as in BD
  • added new parameter to modelStudio(): max_features_fi = max_features, which allows displaying a distinctive number of features in FI plot (other than in BD and SV)
  • added new options to ms_options(): **_axis_title, which allow changing plot-specific axis title (default varies)

v3.0.0

2 years ago
  • BREAKING CHANGES:
    • this version requires R >=3.6, DALEX >=2.2.1, ingredients >=2.2.0 and iBreakDown >=2.0.1
    • the deprecated alias modelStudioOptions() is removed from this version of the package; after being deprecated for over a year since v1.1.0. Use the recommended ms_options() instead.
    • added new parameter to modelStudio(): N_sv = 3*N, which by default decreases the number of observations used for the calculation of Shapley Values (rows in data)
    • margin_left = NULL by default and it is adjusted based on the length of variable names
    • the first plot opened in the dashboard is now FI instead of BD by default
  • added the verbose parameter to modelStudio() as an alias to show_info (#101)
  • added new ms_merge_observations() function that merges local explanation of observations from multiple modelStudio objects (#102)

v2.1.2

3 years ago
  • fixed an error in modelStudio() when data had only one variable (#99)
  • fix CRAN checks

v2.1.0

3 years ago
  • DEFAULTS CHANGES: if new_observation = NULL then choose new_observation_n = 3 observations, evenly spread by the order of y_hat. This shall always include the observations, which ids are which.min(y_hat) and which.max(y_hat). Additionally, improve the observation dropdown text in dashboard. (#94)
  • updated the progress printing
  • this version requires DALEX v2.0.1
  • added new options to ms_options: ms_subtitle, ms_margin_top and ms_margin_bottom
  • added new parameters to modelStudio(): N_fi = 10*N and B_fi = B
  • added new license parameter to modelStudio() which allows to specify the connection for readLines() (e.g. 'LICENSE') which will add file contents into the HTML output as a comment

v2.0.0

3 years ago
  • this version requires DALEX v2.0, ingredients v2.0 and iBreakDown v1.3.1
  • The dashboard gathers useful, but not sensitive, information about how it is being used (e.g. computation length, package version, dashboard dimensions). This is for the development purposes only and can be blocked by setting telemetry to FALSE.
  • add support for modelStudio in Shiny (#77) using new widget_id argument
  • modelStudio now works with NA in data (#71)
  • CP, PD and AD plots are now calculated with variable_splits_type='uniform' and CP plots are now calculated with variable_splits_with_obs=TRUE (#74)
  • By default the loss_function in FI is now different for each explainer$model_info$type (#73)
  • fixed a bug where passing additional parameters in ... would cause an error
  • added a max_vars alias for the max_features parameter
  • added median line to the boxplots in FI and SV plots, added boxplots to TV categorical plots (regression)
  • TV plot uses boxplots and barplot when the target y has only two unique values (classification) (#76)
  • added more checks for input
  • added the Residuals vs Feature plot (RV) (#84)
  • added model performance measures to the footnote #(85)

v1.2.0

3 years ago
  • remove redundant documentation resources so that the package weights less
  • add a second dropdown list for variable change
  • fix check class warning
  • add stringsAsFactors=TRUE where data.frame is used

v1.1.0

3 years ago
  • rename modelStudioOptions() to ms_options()
  • add new ms_update_options() function that updates the options of a modelStudio object
  • add new ms_update_observations() function that updates the observations of a modelStudio object
  • lower B default value from 15 to 10 and N default value from 400 to 300
  • feature_importance is now calculated on 10*N sampled rows from the data
  • use ranger instead of randomForest everywhere
  • remove unnecessary imports, update the documentation
  • added auto_unbox = TRUE to jsonlite::toJSON and changed the .js code to comply
  • add new class "modelStudio" to the modelStudio() output

v1.0.2

4 years ago
  • fix FD plot on matrix-like data
  • center modelStudio position in HTML
  • modelStudio now renders properly from .Rmd to .html

v1.0.1

4 years ago
  • stable release after fixing minor issues
  • comply with R v4.0 changes
  • add support for matrix-like data with xgboost working example
  • boxplot whiskers end in max(min, q1 - 1.5*iqr) and min(max, q3 + 1.5*iqr)
  • upgrade show_info with progress package