Skip to content

Commit

Permalink
Added README to contrib folder for Snorkel DB backend
Browse files Browse the repository at this point in the history
  • Loading branch information
ajratner committed Nov 17, 2018
1 parent 0beb48a commit 7e3a838
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions metal/contrib/backends/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Backends

### Snorkel Databases
This provides a generic wrapper class for using Snorkel v0.7 databases in MeTal. We make several assumptions when using this class:
- The snorkel database is fully initialized (e.g., candidates, splits, probabilistic and gold labels are pre-defined).
- The application is a standard unary/binary relation extraction task.
- The dataset fits in local memory.

Usage example:
```
db_conn_str = "cdr.db"
candidate_def = ['ChemicalDisease', ['chemical', 'disease']]
train, dev, test = SnorkelDataset.splits(db_conn_str, candidate_def)
```

0 comments on commit 7e3a838

Please sign in to comment.