Skip to content

Commit

Permalink
Update README to include benchmarks gist
Browse files Browse the repository at this point in the history
  • Loading branch information
MattGPT-ai committed Sep 6, 2023
1 parent 773ee50 commit ccdcc43
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@

## fast_censor

* A fast and flexible package for filtering out profanity or other strings from text, ~300 times faster than alternatives
* A fast and flexible package for filtering out profanity or other strings from text, ~100 times faster than alternatives
* the fastest string utility for profanity detection / censoring
* allows for detection with repeated characters and character substition

* Allows for detection with repeated characters and character substitution
* Requires zero dependencies and works for python 3.6 -- 3.11

## Installation

Expand Down Expand Up @@ -70,4 +70,10 @@ For example, if `'_'` is a delimiter, "ba_t" would not match "bat"

### Encoding
By default, the word lists are base64-encoded, so you can avoid displaying vulgar or offensive words.
If you would like to save a word list in plain text, set `encode=False` in `write_words_file`
If you would like to save a word list in plain text, set `encode=False` in `write_words_file`


## Benchmarks
See `notebooks/benchmarks.ipynb` for details

See: [This Gist](https://gist.github.com/mbuchove/02752cd868b6cc207b0b1261b015be3a)

0 comments on commit ccdcc43

Please sign in to comment.