Skip to content

2.0.0

Compare
Choose a tag to compare
@mikix mikix released this 27 Jun 14:26
· 8 commits to main since this release
075d567

This release re-organizes the CLI commands a bit and adds some new ones!

Breaking changes

  • chart-review info has been removed, as it was in danger of becoming a kitchen sink with no clear purpose. Instead:
    • The default chart-review info output of annotators and their chart ranges has been moved to the default chart-review output when you don't provide a sub-command.
    • chart-review info --ids has been moved to chart-review ids (and now prints a human-readable table by default - pass --csv to get the previous CSV-formatted output)
    • chart-review info --labels has been moved to chart-review labels

New features

  • You can now see a list of all text mentions and how they were labeled with chart-review mentions:
$ chart-review mentions
╭───────────┬──────────┬─────────┬───────╮
│ Annotator │ Chart ID │ Mention │ Label │
├───────────┼──────────┼─────────┼───────┤
│ mike      │ 1        │ sigh    │ sad   │
│ mike      │ 1        │ woo     │ happy │
╰───────────┴──────────┴─────────┴───────╯
  • You can now see a count of how often each text mentions was labeled with chart-review frequency:
$ chart-review frequency
╭───────────┬───────┬─────────┬───────╮
│ Annotator │ Label │ Mention │ Count │
├───────────┼───────┼─────────┼───────┤
│ All       │ happy │ woo     │ 1     │
│ All       │ sad   │ sigh    │ 4     │
├───────────┼───────┼─────────┼───────┤
│ andy      │ happy │ woo     │ 1     │
│ andy      │ sad   │ sigh    │ 1     │
├───────────┼───────┼─────────┼───────┤
│ april     │ happy │ woo     │ 1     │
│ april     │ sad   │ sigh    │ 3     │
╰───────────┴───────┴─────────┴───────╯
  • You can now pass chart-review accuracy --verbose to see a per-label breakdown of the True Positives / False Negatives / etc:
$ chart-review accuracy jill jane --verbose
╭──────────┬──────────┬────────────────╮
│ Chart ID │ Label    │ Classification │
├──────────┼──────────┼────────────────┤
│ 1        │ Cough    │ TP             │
│ 1        │ Fatigue  │ TP             │
├──────────┼──────────┼────────────────┤
│ 4        │ Cough    │ FP             │
│ 4        │ Fatigue  │ TP             │
╰──────────┴──────────┴────────────────╯
  • All commands have gained a --csv argument to print a CSV-formatted version of the command's output
  • You can now see the current version with chart-review --version
  • You can now use the shortened -p flag instead of the long-form --project-dir

Other changes:

  • When you run chart-review in a project that isn't properly set up yet (no config.yaml or label studio export), a much clearer error is printed, pointing to the web documentation
  • The chart-review accuracy --save option has been deprecated and hidden from the --help output. Use the now-standardized accuracy --csv option and redirect the output to a file instead