Skip to content

Correct model name in README examples #12

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
fcakyon merged 1 commit into from
Nov 9, 2025
Merged

Correct model name in README examples #12

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Python API:
from moderators import AutoModerator

# Load from the Hugging Face Hub (e.g., NSFW image classifier)
moderator = AutoModerator.from_pretrained("viddexa/nsfw-mini")
moderator = AutoModerator.from_pretrained("viddexa/nsfw-detector-mini")

# Run on a local image path
result = moderator("/path/to/image.jpg")
Expand All @@ -61,7 +61,7 @@ print(result)

CLI:
```bash
moderators viddexa/nsfw-mini /path/to/image.jpg
moderators viddexa/nsfw-detector-mini /path/to/image.jpg
```

Text example (sentiment/toxicity):
Expand Down Expand Up @@ -103,7 +103,7 @@ Tip (Python):
from dataclasses import asdict
from moderators import AutoModerator

moderator = AutoModerator.from_pretrained("viddexa/nsfw-mini")
moderator = AutoModerator.from_pretrained("viddexa/nsfw-detector-mini")
result = moderator("/path/to/image.jpg")
json_ready = [asdict(r) for r in result]
print(json_ready)
Expand Down Expand Up @@ -148,7 +148,7 @@ The table below places Moderators next to the raw Transformers `pipeline()` usag


## Pick a model
- From the Hub: pass a model id like `viddexa/nsfw-mini` or any compatible Transformers model.
- From the Hub: pass a model id like `viddexa/nsfw-detector-mini` or any compatible Transformers model.
- From disk: pass a local folder that contains a `config.json` next to your weights.

Moderators detects the task and integration from the config when possible, so you don’t have to specify pipelines manually.
Expand All @@ -169,7 +169,7 @@ Examples:
```
- Image classification (local image):
```bash
moderators viddexa/nsfw-mini /path/to/image.jpg
moderators viddexa/nsfw-detector-mini /path/to/image.jpg
```

Tips:
Expand Down