deploy: 4ed8c7c

.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 70f3f7e6f999a68e44de39d7d891cffc
+tags: 645f666f9bcd5a90fca523b33c5a78b7

_sources/contributing.md.txt

@@ -0,0 +1,102 @@
+# Contributing to Hezar
+Welcome to Hezar! We greatly appreciate your interest in contributing to this project and helping us make it even more
+valuable to the Persian community. Whether you're a developer, researcher, or enthusiast, your contributions are
+invaluable 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 to
+the [Contributor Code of Conduct](https://github.com/hezarai/hezar/blob/main/CODE_OF_CONDUCT.md).
+
+## How to Contribute
+
+### Reporting Bugs
+
+If you come across a bug or unexpected behavior, please help us by reporting it.
+Use the [GitHub Issue Tracker](https://github.com/hezarai/hezar/issues) 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 suggestion
+with a clear description and further suggestions on how it can be implemented. Also, if you already can implement it
+yourself, 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!<br>
+Here's how you can get involved:<br>
+Docs website is deployed here: [https://hezarai.github.io/hezar](https://hezarai.github.io/hezar) and the source for the
+docs are located at the [docs](https://github.com/hezarai/hezar/tree/main/docs) folder in the root of the repo. Feel
+free to apply your changes or add new docs to this section. Notice that docs are written in Markdown format. In case you have
+added new files to this section, you must include them in the `index.md` file in the same folder. For example, if you've
+added the file `new_doc.md` to the `get_started` folder, you have to modify `get_started/index.md` and put your file
+name 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 in
+  parentheses (e.g., "Add NFKC normalizer (#9999)").
+- Reference codes & paths in back quotes (e.g., `variable`, `method()`, `Class()`, `file.py`).
+- Preferably use the following [gitmoji](https://gitmoji.dev/) compatible codes at the beginning of your commit message:
+
+| Emoji Code           | Emoji | Description                                  | Example Commit                                                 |
+|----------------------|-------|----------------------------------------------|----------------------------------------------------------------|
+| `:bug:`              | 🐛    | Fix a bug or issue                           | `:bug: Fix issue with image loading in DataLoader`             |
+| `:sparkles:`         | ✨     | Add feature or improvements                  | `:sparkles: Introduce support for text summarization`          |
+| `:recycle:`          | ♻️    | Refactor code (backward compatible refactor) | `:recycle: Refactor data preprocessing utilities`              |
+| `:memo:`             | 📝    | Add or change docs                           | `:memo: Update documentation for text classification`          |
+| `:pencil2:`          | ✏️    | Minor change or improvement                  | `:pencil2: Improve logging in Trainer`                         |
+| `:fire:`             | 🔥    | Remove code or file                          | `:fire: Remove outdated utility function`                      |
+| `:boom:`             | 💥    | Introduce breaking changes                   | `:boom: Update API, requires modification in existing scripts` |
+| `:test_tube:`        | 🧪    | Test-related changes                         | `:test_tube: Add unit tests for data loading functions`        |
+| `:bookmark:`         | 🔖    | Version release                              | `:bookmark: Release v1.0.0`                                    |
+| `:adhesive_bandage:` | 🩹    | Non-critical fix                             | `:adhesive_bandage: Fix minor issue in BPE tokenizer`          |
+
+## Sending a PR
+
+In order to apply any change to the repo, you have to follow these step:
+
+1. Fork the Hezar repository.
+2. Create a new branch for your feature, bug fix, etc.
+3. Make your changes.
+4. Update the documentation to reflect your changes.
+5. Ensure your code adheres to the [Google Python Style Guide](https://google.github.io/styleguide/pyguide.html).
+6. Format the code using `ruff` (`ruff check --fix .`)
+7. Write tests to ensure the functionality if needed.
+8. Run tests and make sure all of them pass. (Skip this step if your changes do not involve codes)
+9. Open a pull request from your fork and the PR template will be automatically loaded to help you do the rest.
+10. Be responsive to feedback and comments during the review process.
+11. Thanks for contributing to the Hezar project.😉❤️
+
+## License
+
+By contributing to Hezar, you agree that your contributions will be licensed under
+the [Apache 2.0 License](https://github.com/hezarai/hezar/blob/main/LICENSE).
+
+We look forward to your contributions and appreciate your efforts in making Hezar a powerful AI tool for the Persian
+community!

_sources/get_started/index.md.txt

@@ -0,0 +1,8 @@
+# Get Started
+```{toctree}
+:maxdepth: 1
+
+overview.md
+installation.md
+quick_tour.md
+```

_sources/get_started/installation.md.txt

@@ -0,0 +1,44 @@
+# Installation
+
+## Install from PyPi
+Installing Hezar is as easy as any other Python library! Most of the requirements are cross-platform and installing
+them on any machine is a piece of cake!
+
+```
+pip install hezar
+```
+```{note}
+Since v0.39.0, `hezar` is only installable with `Python 3.10` or later!
+```
+### Installation variations
+Hezar is packed with a lot of tools that are dependent on other packages. Most of the
+time you might not want everything to be installed, hence, providing multiple variations of
+Hezar so that the installation is light and fast for general use.
+
+You can install optional dependencies for each mode like so:
+```
+pip install hezar[nlp]  # For natural language processing
+pip install hezar[vision]  # For computer vision and image processing
+pip install hezar[audio]  # For audio and speech processing
+pip install hezar[embeddings]  # For word embeddings
+```
+Or you can also install everything using:
+```
+pip install hezar[all]
+```
+## Install from source
+Also, you can install the dev version of the library using the source:
+```
+pip install git+https://github.com/hezarai/hezar.git
+```
+
+## Test installation
+From a Python console or in CLI just import `hezar` and check the version:
+```python
+import hezar
+
+print(hezar.__version__)
+```
+```
+0.39.1
+```

_sources/get_started/overview.md.txt

@@ -0,0 +1,20 @@
+# Overview
+
+Welcome to Hezar! A library that makes state-of-the-art machine learning as easy as possible aimed for the Persian
+language, built by the Persian community!
+
+In Hezar, the primary goal is to provide plug-and-play AI/ML utilities so that you don't need to know much about what's
+going on under the hood. Hezar is not just a model library, but instead it's packed with every aspect you need for any
+ML pipeline like datasets, trainers, preprocessors, feature extractors, etc.
+
+Hezar is a library that:
+- brings together all the best works in AI for Persian
+- makes using AI models as easy as a couple of lines of code
+- seamlessly integrates with Hugging Face Hub for all of its models
+- has a highly developer-friendly interface
+- has a task-based model interface which is more convenient for general users.
+- is packed with additional tools like word embeddings, tokenizers, feature extractors, etc.
+- comes with a lot of supplementary ML tools for deployment, benchmarking, optimization, etc.
+- and more!
+
+To find out more, just take the [quick tour](quick_tour.md)!