mirror of
https://github.com/yakhyo/uniface.git
synced 2025-12-30 09:02:25 +00:00
3982d677a9
* ref: Remove type conversion and update face class * fix: change the type to float32 * chore: Update all examples, testing with latest version * docs: Update docs reflecting the recent changes
1.4 KiB
1.4 KiB
Contributing to UniFace
Thank you for considering contributing to UniFace! We welcome contributions of all kinds.
How to Contribute
Reporting Issues
- Use GitHub Issues to report bugs or suggest features
- Include clear descriptions and reproducible examples
- Check existing issues before creating new ones
Pull Requests
- Fork the repository
- Create a new branch for your feature
- Write clear, documented code with type hints
- Add tests for new functionality
- Ensure all tests pass
- Submit a pull request with a clear description
Code Style
- Follow PEP8 guidelines
- Use type hints (Python 3.10+)
- Write docstrings for public APIs
- Keep code simple and readable
Development Setup
git clone https://github.com/yakhyo/uniface.git
cd uniface
pip install -e ".[dev]"
Running Tests
pytest tests/
Examples
Example notebooks demonstrating library usage:
| Example | Notebook |
|---|---|
| Face Detection | face_detection.ipynb |
| Face Alignment | face_alignment.ipynb |
| Face Recognition | face_analyzer.ipynb |
| Face Verification | face_verification.ipynb |
| Face Search | face_search.ipynb |
Questions?
Open an issue or start a discussion on GitHub.