search

clamsproject / aapb-annotations

Repository to store manual annotation dataset developed for CLAMS-AAPB collaboration
3 stars 0 forks source link

Added readme for rfb project #67

Closed jarumihooi closed 3 weeks ago

jarumihooi commented 8 months ago

fixes #65

jarumihooi commented 8 months ago

Requesting review of this readme for developing maturity of the project's documentation. Readme should be in a readable state containing up to present information.

keighrim commented 6 months ago

Let's wait for

If you want to switch the target branch to a somewhat intermediate "develop" branch for RFB in general, feel free to do so. I just don't think the readme file only isn't enough to go into the main branch.

keighrim commented 5 months ago

From yesterday's meeting, here's some (interim) decisions:

  • "raw" annotation files are ready to go public

R2 annotation files are ready.

(interim) For R2 annotation, after eyeballing on the initial IAA results, we decided to use Gabe's as base and do "union" of two annotation sets to create the first public version gold.

  • decision on where to put IAA code

The code is being pushed to https://github.com/clamsproject/aapb-annenv-role-filler-binder/tree/iaa_calculation branch.

  • (possibly) revision of the readme for additional SWT types

We decided a while ago to completely disregard SWT-like subtask from the RFB annotation, so this point shouldn't be relevant any more.

jarumihooi commented 4 months ago

During another conversation, I believe for these two reasons, we decided to hold off on a publicized golds:

  1. We decided to use Gabe's raws as uploaded raws for now.
  2. Other tools may have requests for certain formatting of the golds, therefore more might be required during processing.

Let's scope this issue as starting a readme, documenting the batches, and uploading one of the raws. A new issue can be created for formalizing the golds format and process.py