Skip to content

Commit c36b2fb

Browse files
committed
Update demo links and add Fly/HF deployment docs
1 parent 4efff76 commit c36b2fb

File tree

4 files changed

+192
-98
lines changed

4 files changed

+192
-98
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ a single [ExplainerHub](https://explainerdashboard.readthedocs.io/en/latest/hub.
2424
Dashboards can be exported to static html directly from a running dashboard, or
2525
programmatically as an artifact as part of an automated CI/CD deployment process.
2626

27-
Examples deployed at: [titanicexplainer.herokuapp.com](http://titanicexplainer.herokuapp.com),
27+
Examples deployed at: [Fly.io](https://titanicexplainer.fly.dev), [Hugging Face Space](https://huggingface.co/spaces/oegedijk/explainingtitanic),
2828
detailed documentation at [explainerdashboard.readthedocs.io](http://explainerdashboard.readthedocs.io),
2929
example notebook on how to launch dashboard for different models [here](notebooks/dashboard_examples.ipynb), and an example notebook on how to interact with the explainer object [here](notebooks/explainer_examples.ipynb).
3030

@@ -87,7 +87,7 @@ Auto-detection uses the presence of `/opt/ml/metadata/resource-metadata.json`.
8787
![explainerdashboard.gif](explainerdashboard.gif)
8888

8989
<!-- [![Dashboard Screenshot](https://i.postimg.cc/Gm8RnKVb/Screenshot-2020-07-01-at-13-25-19.png)](https://postimg.cc/PCj9mWd7) -->
90-
(for live demonstration see [titanicexplainer.herokuapp.com](http://titanicexplainer.herokuapp.com))
90+
(for live demonstration see [Fly.io](https://titanicexplainer.fly.dev) or [Hugging Face Space](https://huggingface.co/spaces/oegedijk/explainingtitanic))
9191
## Background
9292

9393
In a lot of organizations, especially governmental, but with the GDPR also increasingly in private sector, it is becoming more and more important to be able to explain the inner workings of your machine learning algorithms. Customers have to some extent a right to an explanation why they received a certain prediction, and more and more internal and external regulators require it. With recent innovations in explainable AI (e.g. SHAP values) the old black box trope is no longer valid, but it can still take quite a bit of data wrangling and plot manipulation to get the explanations out of a model. This library aims to make this easy.
@@ -533,7 +533,7 @@ own model, project and needs. You can use the [ExplainerComposites](https://gith
533533
are used for the tabs of the default dashboard as a starting point, and edit
534534
them to reorganize components, add text, etc.
535535
See [custom dashboard documentation](https://explainerdashboard.readthedocs.io/en/latest/custom.html)
536-
for more details. A deployed custom dashboard can be found [here](http://titanicexplainer.herokuapp.com/custom/)([source code](https://github.com/oegedijk/explainingtitanic/blob/master/buildcustom.py)).
536+
for more details. A deployed custom dashboard can be found on [Fly.io](https://titanicexplainer.fly.dev/custom/)([source code](https://github.com/oegedijk/explainingtitanic/blob/master/buildcustom.py)).
537537

538538
## Deployment
539539

@@ -543,6 +543,10 @@ start the server with e.g. `gunicorn dashboard:app`
543543
(assuming the file you defined the dashboard in was called `dashboard.py`).
544544
See also the [ExplainerDashboard section](https://explainerdashboard.readthedocs.io/en/latest/dashboards.html)
545545
and the [deployment section of the documentation](https://explainerdashboard.readthedocs.io/en/latest/deployment.html).
546+
For platform-specific guides, see:
547+
[Deploying to Fly.io](https://explainerdashboard.readthedocs.io/en/latest/deployment.html#deploying-to-fly-io)
548+
and
549+
[Deploying to Hugging Face Spaces](https://explainerdashboard.readthedocs.io/en/latest/deployment.html#deploying-to-hugging-face-spaces).
546550

547551
It can be helpful to store your `explainer` and dashboard layout to disk, and
548552
then reload, e.g.:
@@ -647,7 +651,7 @@ Example notebook on how to design a custom dashboard: [custom_examples.ipynb](no
647651

648652
## Deployed example:
649653

650-
You can find an example dashboard at [titanicexplainer.herokuapp.com](http://titanicexplainer.herokuapp.com)
654+
You can find example dashboards at [Fly.io](https://titanicexplainer.fly.dev) and [Hugging Face Space](https://huggingface.co/spaces/oegedijk/explainingtitanic)
651655

652656
(source code at [https://github.com/oegedijk/explainingtitanic](https://github.com/oegedijk/explainingtitanic))
653657

0 commit comments

Comments
 (0)