dssg / dssg/triage

Postmodeling: Reorganize Tutorial

Open
#655 0 comments 1 reaction 0 assignees View on GitHub
postmodeling
Dominant language
Jupyter Notebook
Stars
201
Forks
62
PR merge metrics
No merged PRs in 30d

Description

We should consider restructuring the [postmodeling tutorial notebook](https://github.com/dssg/triage/blob/master/src/triage/component/postmodeling/contrast/postmodeling_tutorial.ipynb) to provide a more natural user flow, for instance:
- Moving the model group evaluation and performance metrics up front to potentially help choose a model to investigate in more detail.
- Adding a little more guidance on how to make use of the different postmodeling tools, what actions to consider taking based on the results of each analysis.

Contributor guide

Open the contributing guide

Research direction

Open src/triage/component/postmodeling/contrast/postmodeling_tutorial.ipynb and review the current sequence of postmodeling analyses. Consider how model group evaluation and performance metrics could guide which model to investigate, then define the guidance users need for interpreting each tool and choosing follow-up actions. Done means the notebook presents a natural user flow and explains how to act on its results.

Written by the indexing model from the issue text.

Assessment

Tech stack
jupyter-notebook
Domain
documentation, machine-learning
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.