- Get Started
- Tutorial
- Developer Guides
- Reference API
- hezar package
- hezar.data package
- hezar.data.datasets package
- hezar.data.datasets.dataset module
- hezar.data.datasets.image_captioning_dataset module
- hezar.data.datasets.ocr_dataset module
- hezar.data.datasets.sequence_labeling_dataset module
- hezar.data.datasets.speech_recognition_dataset module
- hezar.data.datasets.text_classification_dataset module
- hezar.data.datasets.text_summarization_dataset module
- hezar.data.data_collators module
- hezar.data.data_samplers module
- hezar.data.dataset_processors module
- hezar.data.datasets package
- hezar.embeddings package
- hezar.metrics package
- hezar.models package
- hezar.models.backbone package
- hezar.models.image2text package
- hezar.models.mask_filling package
- hezar.models.sequence_labeling package
- hezar.models.speech_recognition package
- hezar.models.text_classification package
- hezar.models.text_detection package
- hezar.models.text_generation package
- hezar.models.model module
- hezar.models.model_outputs module
- hezar.preprocessors package
- hezar.trainer package
- hezar.utils package
- hezar.builders module
- hezar.configs module
- hezar.constants module
- hezar.registry module
- hezar.data package
- hezar package
- Contributing to Hezar
Contributing to Hezar¶
Welcome to Hezar! We greatly appreciate your interest in contributing to this project and helping us make it even morevaluable to the Persian community. Whether you’re a developer, researcher, or enthusiast, your contributions areinvaluable in helping us grow and improve Hezar.
Before you start contributing, please take a moment to review the following guidelines.
Code of Conduct¶
This project and its community adhere totheContributor Code of Conduct.
How to Contribute¶
Reporting Bugs¶
If you come across a bug or unexpected behavior, please help us by reporting it.Use theGitHub Issue Tracker to create a detailed bug report.Include information such as:
A clear and descriptive title.
Steps to reproduce the bug.
Expected behavior.
Actual behavior.
Your operating system and Python version.
Adding features¶
Have a great idea for a new feature or improvement? We’d love to hear it. You can open an issue and add your suggestionwith a clear description and further suggestions on how it can be implemented. Also, if you already can implement ityourself, just follow the instructions on how you can send a PR.
Adding/Improving documents¶
Have a suggestion to enhance our documentation or want to contribute entirely new sections? We welcome your input!
Here’s how you can get involved:
Docs website is deployed here:https://hezarai.github.io/hezar and the source for thedocs are located at thedocs folder in the root of the repo. Feelfree to apply your changes or add new docs to this section. Notice that docs are written in Markdown format. In case you haveadded new files to this section, you must include them in theindex.md file in the same folder. For example, if you’veadded the filenew_doc.md to theget_started folder, you have to modifyget_started/index.md and put your filename there.
Commit guidelines¶
Functional best practices¶
Ensure only one “logical change” per commit for efficient review and flaw identification.
Smaller code changes facilitate quicker reviews and easier troubleshooting using Git’s bisect capability.
Avoid mixing whitespace changes with functional code changes.
Avoid mixing two unrelated functional changes.
Refrain from sending large new features in a single giant commit.
Styling best practices¶
Use imperative mood in the subject (e.g., “Add support for …” not “Adding support or added support”) .
Keep the subject line short and concise, preferably less than 50 characters.
Capitalize the subject line and do not end it with a period.
Wrap body lines at 72 characters.
Use the body to explain what and why a change was made.
Do not explain the “how” in the commit message; reserve it for documentation or code.
For commits referencing an issue or pull request, write the proper commit subject followed by the reference inparentheses (e.g., “Add NFKC normalizer (#9999)”).
Reference codes & paths in back quotes (e.g.,
variable,method(),Class(),file.py).Preferably use the followinggitmoji compatible codes at the beginning of your commit message:
Emoji Code | Emoji | Description | Example Commit |
|---|---|---|---|
| 🐛 | Fix a bug or issue |
|
| ✨ | Add feature or improvements |
|
| ♻️ | Refactor code (backward compatible refactor) |
|
| 📝 | Add or change docs |
|
| ✏️ | Minor change or improvement |
|
| 🔥 | Remove code or file |
|
| 💥 | Introduce breaking changes |
|
| 🧪 | Test-related changes |
|
| 🔖 | Version release |
|
| 🩹 | Non-critical fix |
|
Sending a PR¶
In order to apply any change to the repo, you have to follow these step:
Fork the Hezar repository.
Create a new branch for your feature, bug fix, etc.
Make your changes.
Update the documentation to reflect your changes.
Ensure your code adheres to theGoogle Python Style Guide.
Format the code using
ruff(ruffcheck--fix.)Write tests to ensure the functionality if needed.
Run tests and make sure all of them pass. (Skip this step if your changes do not involve codes)
Open a pull request from your fork and the PR template will be automatically loaded to help you do the rest.
Be responsive to feedback and comments during the review process.
Thanks for contributing to the Hezar project.😉❤️
License¶
By contributing to Hezar, you agree that your contributions will be licensed undertheApache 2.0 License.
We look forward to your contributions and appreciate your efforts in making Hezar a powerful AI tool for the Persiancommunity!