docs: enhance README with installation instructions, usage examples, … #7
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…and troubleshooting tips
Contributor
|
Looks great! 🚀 |
fcakyon
approved these changes
Oct 14, 2025
Collaborator
|
eline saglik Abdullah abi! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request significantly improves the documentation for the Moderators project, making it much more user-focused and practical. The
README.mdis refactored to provide clear installation steps, usage examples, output formats, troubleshooting, and a comparison with raw Transformers pipelines. Additionally, a newexamples/README.mdis added to help users quickly get started and benchmark models.Major improvements to documentation and user onboarding:
User-focused README overhaul:
README.mdto target developers and researchers, adding clear installation instructions, API and CLI usage examples, normalized output formats, and troubleshooting guidance. Also includes a feature comparison table with Transformers pipelines and a roadmap for future integrations.Practical example scripts and tips:
examples/README.mdwith hands-on Python and CLI quickstart guides, batch processing examples, benchmarking instructions, and troubleshooting tips for common issues.