AutoDoc Settings¶
This section includes settings that can be used to configure AutoDoc.
Make AutoDoc¶
Specify whether to create an AutoDoc for the experiment after it has finished running. This is enabled by default.
AutoDoc Name¶
Specify a name for the AutoDoc report. This is set to “report” by default.
AutoDoc Template Location¶
Specify a path for the AutoDoc template:
To generate a custom AutoDoc template, specify the full path to your custom template.
To generate the standard AutoDoc, specify the default value for this setting.
AutoDoc File Output Type¶
Specify the AutoDoc output type. Choose from the following file types:
docx (Default)
md
AutoDoc SubTemplate Type¶
Specify the type of sub-templates to use. Choose from the following:
auto (Default)
md
docx
Confusion Matrix Max Number of Classes¶
Specify the maximum number of classes in the confusion matrix. This value defaults to 10.
Number of Top Features to Document¶
Specify the number of top features to display in the document. To disable this setting, specify -1. This is set to 50 by default.
Minimum Relative Feature Importance Threshold¶
Specify the minimum relative feature importance in order for a feature to be displayed. This value must be a float >= 0 and <= 1. This is set to 0.003 by default.
Permutation Feature Importance¶
Specify whether to compute permutation-based feature importance. This is disabled by default.
Number of Permutations for Feature Importance¶
Specify the number of permutations to make per feature when computing feature importance. This is set to 1 by default.
Feature Importance Scorer¶
Specify the name of the scorer to be used when calculating feature importance. Leave this setting unspecified to use the default scorer for the experiment.
PDP Max Number of Rows¶
Specify the number of rows for Partial Dependence Plots.
PDP Max Runtime in Seconds¶
Specify the maximum number of seconds Partial Dependency computation can take when generating a report. Set this value to -1 to disable the time limit. This is set to 20 seconds by default.
PDP Out of Range¶
Specify the number of standard deviations outside of the range of a column to include in partial dependence plots. This shows how the model reacts to data it has not seen before. This is set to 3 by default.
ICE Number of Rows¶
Specify the number of rows to include in PDP and ICE plots if individual rows are not specified. This is set to 0 by default.
Population Stability Index¶
Specify whether to include a population stability index if the experiment is a binary classification or regression problem. This is disabled by default.
Population Stability Index Number of Quantiles¶
Specify the number of quantiles to use for the population stability index. This is set to 10 by default.
Prediction Statistics¶
Specify whether to include prediction statistics information if the experiment is a binary classification or regression problem. This value is disabled by default.
Prediction Statistics Number of Quantiles¶
Specify the number of quantiles to use for prediction statistics. This is set to 20 by default.
Response Rates Plot¶
Specify whether to include response rates information if the experiment is a binary classification problem. This is disabled by default.
Response Rates Plot Number of Quantiles¶
Specify the number of quantiles to use for response rates information. This is set to 10 by default.
Show GINI Plot¶
Specify whether to show the GINI plot. This is disabled by default.
Enable Shapley Values¶
Specify whether to show Shapley values results in the AutoDoc. This is enabled by default.
Number of Features in Data Summary Table¶
Specify the number of features to be shown in the data summary table. This value must be an integer. To show all columns, specify any value lower than 1. This is set to -1 by default.
List All Config Settings¶
Specify whether to show all config settings. If this is disabled, only settings that have been changed are listed. All settings are listed when enabled. This is disabled by default.
Keras Model Architecture Summary Line Length¶
Specify the line length of the Keras model architecture summary. This value must be either an integer greater than 0 or -1. To use the default line length, set this value to -1 (default).
NLP/Image Transformer Architecture Max Lines¶
Specify the maximum number of lines shown for advanced transformer architecture in the Feature section. Note that the full architecture can be found in the appendix.
Appendix NLP/Image Transformer Architecture¶
Specify whether to show the full NLP/Image transformer architecture in the appendix. This is disabled by default.
Full GLM Coefficients Table in the Appendix¶
Specify whether to show the full GLM coefficient table(s) in the appendix. This is disabled by default.
GLM Coefficient Tables Number of Models¶
Specify the number of models for which a GLM coefficients table is shown in the AutoDoc. This value must be -1 or an integer >= 1. Set this value to -1 to show tables for all models. This is set to 1 by default.
GLM Coefficient Tables Number of Folds Per Model¶
Specify the number of folds per model for which a GLM coefficients table is shown in the AutoDoc. This value must be be -1 (default) or an integer >= 1 (-1 shows all folds per model).
GLM Coefficient Tables Number of Coefficients¶
Specify the number of coefficients to show within a GLM coefficients table in the AutoDoc. This is set to 50 by default. Set this value to -1 to show all coefficients.
GLM Coefficient Tables Number of Classes¶
Specify the number of classes to show within a GLM coefficients table in the AutoDoc. Set this value to -1 to show all classes. This is set to 9 by default.
Number of Histograms to Show¶
Specify the number of top features for which to show histograms. This is set to 10 by default.