Skip to content

Commit

Permalink
fix: remove auto cohorts plot from tutorial
Browse files Browse the repository at this point in the history
Those plots cannot be generated for a single example.
  • Loading branch information
desilinguist committed Jan 5, 2024
1 parent 603e367 commit cd4f7f6
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 7 deletions.
9 changes: 4 additions & 5 deletions doc/tutorial_rsmexplain.rst.inc
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,6 @@ Let's take a look at the options in our configuration file.
- **Line 7**: :ref:`This field <id_column_rsmexplain>` indicates that the unique IDs for the responses in both data files are located in a column named ``ID``.
- **Line 8**: :ref:`This field <sample_size_rsmexplain>` indicates that we wish to explain one *randomly chosen* example from the second data file. If we wish to explain a *specific* example from that file, we would use the :ref:`sample_ids <sample_ids_rsmexplain>` option instead.
- **Line 9**: :ref:`This field <num_features_to_display_rsmexplain>` indicates the number of top features that should be displayed in the plots in the ``rsmexplain`` report.
- **Line 10**: :ref:`This field <show_auto_cohorts_rsmexplain>` indicates whether to show the `automatically generated Cohort bar plots <https://shap.readthedocs.io/en/latest/example_notebooks/api_examples/plots/bar.html#Cohort-bar-plot>`_ in the report.

Documentation for all of the available configuration options is available :ref:`here <config_file_rsmexplain>`.

Expand All @@ -66,12 +65,12 @@ This should produce output like::

Output directory: /Users/nmadnani/work/rsmtool/examples/rsmexplain
Saving configuration file.
WARNING: The following extraneous features will be ignored: {'QUESTION', 'LENGTH', 'score', 'score2', 'L1'}
WARNING: The following extraneous features will be ignored: {'LENGTH', 'score2', 'score'}
Pre-processing input features
WARNING: The following extraneous features will be ignored: {'QUESTION', 'LENGTH', 'score', 'score2', 'L1'}
WARNING: The following extraneous features will be ignored: {'LENGTH', 'score2', 'score'}
Pre-processing input features
Generating SHAP explanations for 10 examples from ../../files/test.csv
100%|███████████████████████████████████████████████████████████████████████| 10/10 [00:00<00:00, 21.99it/s]
Generating SHAP explanations for 1 examples from ../rsmtool/test.csv
100%|███████████████████████████████████████████████████████████████████████| 1/1 [00:00<00:00, 21.99it/s]
Merging sections
Exporting HTML
Success
Expand Down
3 changes: 1 addition & 2 deletions examples/rsmexplain/config_rsmexplain.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,5 @@
"explain_data": "../rsmtool/test.csv",
"id_column": "ID",
"sample_size": 1,
"num_features_to_display": 15,
"show_auto_cohorts": true
"num_features_to_display": 15
}

0 comments on commit cd4f7f6

Please sign in to comment.