Skip to content

Format README to template #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Feb 19, 2025
Merged

Format README to template #2

Changes from 3 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
f6a285a
readme fixes
aaravnavani May 22, 2024
d2db68f
small fix
aaravnavani May 22, 2024
df98c70
terminal command
aaravnavani May 22, 2024
b88b114
__call__ -> validate; document hf token req
CalebCourier Feb 19, 2025
7ace74f
Merge branch 'main' into gibberish_text_fix
CalebCourier Feb 19, 2025
52ab28c
remove double import
CalebCourier Feb 19, 2025
b218115
raise on invalid _validation_method value in validate method
CalebCourier Feb 19, 2025
a7728d7
bump version
CalebCourier Feb 19, 2025
c18520e
add publish workflow
CalebCourier Feb 19, 2025
e19e963
add dev build
CalebCourier Feb 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 9 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
| --- | --- |
| Date of development | Feb 15, 2024 |
| Validator type | Format |
| Blog | - |
| Blog | |
| License | Apache 2 |
| Input/Output | Output |

Expand All @@ -13,12 +13,17 @@
This validator validates the "cleanliness" of the text generated by a language model. It uses a pre-trained model to determine if the text is coherent and not gibberish. The validator can be used to filter out text that is not coherent or does not make sense.

## Requirements
- Dependencies: `nltk`, `transformers`, `torch`

* Dependencies:
- guardrails-ai>=0.4.0
- `nltk`
- `transformers`
- `torch`

## Installation

```bash
guardrails hub install hub://guardrails/gibberish_text
$ guardrails hub install hub://guardrails/gibberish_text
```

## Usage Examples
Expand Down Expand Up @@ -59,7 +64,7 @@ Validation failed for field with errors: The following sentences in your respons
```
**Note: See how only the first 2 sentences within the failing response are considered gibberish.**

## API Reference
# API Reference

**`__init__(self, threshold=0.5, validation_method='sentence', on_fail="noop")`**
<ul>
Expand Down