Skip to content

Commit

Permalink
readme: emailgen info
Browse files Browse the repository at this point in the history
  • Loading branch information
kaustav-goswami committed Dec 7, 2021
1 parent ab10b62 commit 09150ac
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,10 +122,11 @@ python run_tests.py \
```

In the above command, following are the parameters:
* `--type` signifies the tests type. Currently we support two types of custom
tests: `sample` and `namegen`. `sample` checks whether a given mail is a job
scam or not. If it is, then it generates a reply and printed on the terminal.
`namegen` is used to generate phantom names.
* `--type` signifies the tests type. Currently we support three types of custom
tests: `sample`, `namegen` and `emailgen`. `sample` checks whether a given
mail is a job scam or not. If it is, then it generates a reply and printed on
the terminal. `namegen` is used to generate phantom names. Similar to
`namegen`, `emailgen` is used to generate name, email pairs.
* `--cmode` signifies the detection mode to use. It either accepts "ML" or
"Generic" as the argument value. "ML" suggests a machine learning mode
whereas "Generic" uses a conditional job scam detection mechanism.
Expand Down

0 comments on commit 09150ac

Please sign in to comment.