mirror of
https://github.com/yakhyo/uniface.git
synced 2025-12-30 09:02:25 +00:00
637316f077
* chore: Style changes and create jupyter notebook template * docs: Update docstring for detection * feat: Keyword only for common parameters: model_name, conf_thresh, nms_thresh, input_size * chore: Update drawing and let the conf text optional for drawing * feat: add fancy bbox draw * docs: Add examples of using UniFace * feat: Add version to all examples
59 lines
1.4 KiB
Markdown
59 lines
1.4 KiB
Markdown
# 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
|
|
|
|
1. Fork the repository
|
|
2. Create a new branch for your feature
|
|
3. Write clear, documented code with type hints
|
|
4. Add tests for new functionality
|
|
5. Ensure all tests pass
|
|
6. 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
|
|
|
|
```bash
|
|
git clone https://github.com/yakhyo/uniface.git
|
|
cd uniface
|
|
pip install -e ".[dev]"
|
|
```
|
|
|
|
## Running Tests
|
|
|
|
```bash
|
|
pytest tests/
|
|
```
|
|
|
|
## Examples
|
|
|
|
Example notebooks demonstrating library usage:
|
|
|
|
| Example | Notebook |
|
|
|---------|----------|
|
|
| Face Detection | [face_detection.ipynb](examples/face_detection.ipynb) |
|
|
| Face Alignment | [face_alignment.ipynb](examples/face_alignment.ipynb) |
|
|
| Face Recognition | [face_analyzer.ipynb](examples/face_analyzer.ipynb) |
|
|
| Face Verification | [face_verification.ipynb](examples/face_verification.ipynb) |
|
|
| Face Search | [face_search.ipynb](examples/face_search.ipynb) |
|
|
|
|
## Questions?
|
|
|
|
Open an issue or start a discussion on GitHub.
|
|
|