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

API document for ExplainableBoosting{xxx}? #194

Closed
AllardJM opened this issue Jan 14, 2021 · 6 comments
Closed

API document for ExplainableBoosting{xxx}? #194

AllardJM opened this issue Jan 14, 2021 · 6 comments

Comments

@AllardJM
Copy link

I cant seem to locate an API dictionary for ExplainableBoostingRegressor or ExplainableBoostingClassifier. Does this not exist? I was looking for an understanding about what are acceptable values for feature types and other options.

@mikewlange
Copy link

Hi AllardJM,

Not to sound like an ass, but for this kinda of question, it's better to look it up - you'll learn more. Here are a couple links I just found a second ago. But dig in, look at the source, get those hands dirty.

https://medium.com/analytics-vidhya/explain-your-model-with-microsofts-interpretml-5daab1d693b4
https://medium.com/analytics-vidhya/model-interpretation-with-microsofts-interpret-ml-85aa0ad697ae

@AllardJM
Copy link
Author

Yeah, well atleast you tried.

its strange for a library from a large corp not to have documentation for their API and that was the principal question - if i was missing it.

@mikewlange
Copy link

mikewlange commented Jan 21, 2021

Hey AllardJM,

Sorry - I didn't mean to be imprecise in my last comment. When you're passing data to you the Fit function (one way) would pass in returns from https://scikit-learn.org/stable/modules/generated/sklearn.model_selection.train_test_split.html .

for example - pull out the arrays from your main data after munging:

X_train, X_test, y_train, y_test = train_test_split(X_enc, y, test_size=0.20, random_state=seed)

then for a RandomForestClassifier

from sklearn.ensemble import RandomForestClassifier
from sklearn.decomposition import PCA
from sklearn.pipeline import Pipeline

'pca = PCA()
rf = RandomForestClassifier(n_estimators=100, n_jobs=-1)
blackbox_model = Pipeline([('pca', pca), ('rf', rf)])
blackbox_model.fit(X_train, y_train)`

Please study these examples:
https://github.com/interpretml/interpret/tree/develop/examples/python/notebooks

Understand why ^ work and you're good to go.

@interpret-ml
Copy link
Collaborator

Hi @AllardJM --

Welcome back, and thanks again for your help many months ago on the calibration issue. We don't currently have formal documentation, but we do have docstrings that detail many of the options. You can find those at:

https://github.com/interpretml/interpret/blob/develop/python/interpret-core/interpret/glassbox/ebm/ebm.py#L1415

Hi @mikewlange -- thanks for jumping in on this issue last week.

-InterpretML

@interpret-ml
Copy link
Collaborator

Hey @AllardJM and @mikewlange,

We've got official documentation now at https://interpret.ml/docs/. The EBM documentation is here: https://interpret.ml/docs/ebm.html# and includes API docs as well. Feel free to check it out and let us know what you think!

-InterpretML Team

@xiaohk
Copy link
Contributor

xiaohk commented Sep 27, 2021

Hey @AllardJM and @mikewlange, thank you so much for using Interpret! I am Jay Wang, a research intern at the InterpretML team. We are developing a new visualization tool for EBM and recruiting participants for a user study (see #283 for more details).

We think you are a good fit for this paid user study! If you are interested, you can sign up with the link in #283. Let me know if you have any question. Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

4 participants