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

Removes ACV from shapash and fixes dependencies #505

Merged
merged 6 commits into from
Nov 2, 2023
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Replace ACV with Lime in tuto.
  • Loading branch information
MLecardonnel committed Oct 5, 2023
commit 02bb0a402379d972ee181233c4d382a78e48cec3
Original file line number Diff line number Diff line change
Expand Up @@ -240,11 +240,12 @@
"#### First way : using a string\n",
"\n",
"The first way to select your backend is to indicate it using its string name. \n",
"**Existing options are : 'shap' (default), 'lime' and 'acv'**\n",
"**Existing options are : 'shap' (default) and 'lime'.**\n",
"'acv' has been removed from release 2.3.8 because the librairy is not maintained.\n",
"\n",
"Depending on the backend you select, there may be specific argument to pass. \n",
"Please refer to the corresponding documentation for more details. \n",
"For example, below we pass the `data` parameter used by ACV to declare the background."
"For example, below we pass the `data` parameter used by Lime to declare the background."
]
},
{
Expand All @@ -257,8 +258,8 @@
"xpl = SmartExplainer(\n",
" model=clf, \n",
" preprocessing=encoder,\n",
" backend='acv',\n",
" data=Xtrain, # Specific arg used by our backend (here ACV)\n",
" backend='lime',\n",
" data=Xtrain, # Specific arg used by our backend (here Lime)\n",
" features_dict=titan_dict\n",
")"
]
Expand Down Expand Up @@ -308,7 +309,7 @@
"#### Second way : using the backend class\n",
"\n",
"Another way is to use the specific backend class and instanciate it before passing it to the `backend` parameter. \n",
"Existing backend classes are : `ShapBackend`, `AcvBackend` and `LimeBackend`"
"Existing backend classes are : `ShapBackend` and `LimeBackend`"
]
},
{
Expand All @@ -326,14 +327,14 @@
}
],
"source": [
"from shapash.backend import AcvBackend\n",
"from shapash.backend import LimeBackend\n",
"\n",
"acv_backend = AcvBackend(model=clf, data=Xtrain)\n",
"lime_backend = LimeBackend(model=clf, data=Xtrain)\n",
"\n",
"xpl = SmartExplainer(\n",
" model=clf, \n",
" preprocessing=encoder,\n",
" backend=acv_backend,\n",
" backend=lime_backend,\n",
" features_dict=titan_dict\n",
")"
]
Expand Down