Skip to content
This repository has been archived by the owner on Nov 3, 2023. It is now read-only.

Commit

Permalink
AcceptabilityChecker doc (#3124)
Browse files Browse the repository at this point in the history
  • Loading branch information
EricMichaelSmith authored Sep 28, 2020
1 parent 22c700a commit 0b1841a
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions parlai/crowdsourcing/utils/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Crowdsourcing utilities

## `acceptability.AcceptabilityChecker`

* Used to make sure that a worker's messages throughout a conversation meet certain criteria (not too short, not all caps, not a lot of repetition, safety, etc.)
### How to add a new check
- Add the code for this in `.check_messages()`, inside a `if 'check_name' in violation_types:` condition
- Add the name of the check to `self.possible_violation_types`; otherwise, this check will not be recognized, and an error will be raised if the check is specified when calling `.check_messages()`!
- To use the check: add the name of the check to the `violation_types` arg when calling `.check_messages()`

0 comments on commit 0b1841a

Please sign in to comment.