Add option to return HMTL object from visualize_text()

[cdpierse]

Related issue: #544

Adds flag return_htmlto visualize_text() that allows for the IPython HTML to be returned if the flag is set to True.

This is useful for cases where users may want to save the output from outside of a notebook etc.

Usage looks like:

from captum.attr import visualization as viz
.... # get attributions and data record


html_obj = viz.visualize_text([score_viz], return_html=True)

[facebook-github-bot]

Hi @cdpierse!

Thank you for your pull request and welcome to our community. We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file.

In order for us to review and merge your code, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

If you have received this in error or have any questions, please contact us at cla@fb.com. Thanks!

[bilalsal]

Thanks @cdpierse for putting this together!

@miguelmartin75 and @vivekmig: do you prefer we add return_html as a parameter? Or to always return the HTML content instead? (the routine currently does not return any value(.

[miguelmartin75]

Thanks @cdpierse for putting this together!

@miguelmartin75 and @vivekmig: do you prefer we add return_html as a parameter? Or to always return the HTML content instead? (the routine currently does not return any value(.

re @bilalsal

I don't see any reason for why we couldn't always return HTML, since this method doesn't return anything and the HTML content is always being constructed.

[NarineK]

Feel free to return HTML. To avoid additional input argument, we can always return HTML and the user can chose to use it or not.

[cdpierse]

I've updated the PR so that HTML is now just always returned by default. Thanks.

[facebook-github-bot]

@bilalsal has imported this pull request. If you are a Facebook employee, you can view this diff on Phabricator.

[facebook-github-bot]

@bilalsal merged this pull request in 4e40f9f.