Skip to content

Commit

Permalink
Modified demo steps
Browse files Browse the repository at this point in the history
  • Loading branch information
sei-glewis committed Jan 7, 2025
1 parent 6ad9733 commit 031824a
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions demo/scenarios/demo_script.txt
Original file line number Diff line number Diff line change
@@ -1,14 +1,16 @@
Pre requirements:

- Have environment running; to do this, execute run_environment.sh from demo/scenarios.
- Have already executed all notebooks that will be shown, so the results can be seen in the notebooks themselves.
Pre-Demo Steps:
- Execute Demo steps from https://mlte.readthedocs.io/en/latest/development/#quickstart.
- Ensure that Docker daemon is running.
- Execute run_environment.sh from demo/scenarios.
- (Optional) Install wget
- Execute all notebooks so that the results can be seen in the notebooks themselves.

Demo:
- Start with slides explaining what MLTE is.
- Continue slides including a diagram of the whole process. Use this diagram later with more slides to indicate where in the process we are as we move forward through the demo.
- Log into frontend (browser, localhost:8000), show Negotiation Card. Explain important parts of negotiation card and how it is refined.
- Open up Jupyter Notebook with Spec (the one in demo/scenarios/1_requirements.ipynb. Note that we may need a slightly modified version if we add a data quality QAS. Skip the Negotiation Card definition, but do show the context initialization, and then the Spec definition. Walk though it without getting into too many details.
- Open the Jupyter Notebook with Spec (the one in demo/scenarios/1_requirements.ipynb. Skip the Negotiation Card definition, but do show the context initialization, and then the Spec definition. Walk though it without getting into too many details.
- Go back to frontend. Show Test Catalog, and show how people would use it find an example of how to measure certain QAS.
- Open up one Jupyter Notebooks with QAS test measurements, the demo/scenarios/2a_evidence_fairness one, and walk through it.
- Open up the demo/scenarios/3_report.ipynb Notebook, and show the process for validating and generating the report.
- Open one Jupyter Notebooks with QAS test measurements, the demo/scenarios/2a_evidence_fairness one, and walk through it.
- Open the demo/scenarios/3_report.ipynb Notebook, and show the process for validating and generating the report.
- Go back to frontend, and show the report results.

0 comments on commit 031824a

Please sign in to comment.