Cleanup

.github/ISSUE_TEMPLATE/bug-report.md

@@ -1,35 +1,36 @@
 ---
-name: "Bug Report"
-about: Submit a bug report to help us improve albumentations
+name: Bug Report
+about: Create a report to help us improve
+title: ''
+labels: 'bug'
+assignees: ''
 
 ---
 
-## 🐛 Bug
+## Describe the bug
 
-<!-- A clear and concise description of what the bug is. -->
+A clear and concise description of what the bug is.
 
-## To Reproduce
+### To Reproduce
 
 Steps to reproduce the behavior:
 
-1.
-1.
-1.
+1. Environment (e.g., OS, Python version, Albumentations version, etc.)
+2. Sample code that produces the bug.
+3. Any error messages or incorrect outputs.
 
-<!-- If you have a code sample, error messages, stack traces, please provide it here as well -->
+### Expected behavior
 
-## Expected behavior
+A clear and concise description of what you expected to happen.
 
-<!-- A clear and concise description of what you expected to happen. -->
+### Actual behavior
 
-## Environment
+Describe what actually happened, including how it differs from your expectations.
 
- - Albumentations version (e.g., 0.1.8):
- - Python version (e.g., 3.7):
- - OS (e.g., Linux):
- - How you installed albumentations (`conda`, `pip`, source):
- - Any other relevant information:
+### Screenshots
 
-## Additional context
+If applicable, add screenshots to help explain your problem.
 
-<!-- Add any other context about the problem here. -->
+### Additional context
+
+Add any other context about the problem here, like links to similar issues or possible solutions you've found.

.github/ISSUE_TEMPLATE/code-quality.md

@@ -0,0 +1,20 @@
+---
+name: Code Quality Improvement
+about: Suggestions for improving code quality, including refactoring and adherence to coding standards
+title: ''
+labels: 'tech debt'
+assignees: ''
+
+---
+
+## Suggested Improvement
+
+Describe the code quality improvement you suggest. This could include refactoring, adherence to coding standards, reducing complexity, etc.
+
+## Potential Benefits
+
+Explain the benefits of your suggested improvement, such as increased maintainability, reduced technical debt, or improved performance.
+
+## Additional Information
+
+Provide any additional information or context that could help understand your suggestion, including code snippets or links to best practices.

.github/ISSUE_TEMPLATE/community.md

@@ -0,0 +1,24 @@
+---
+name: Community and Contributions
+about: Questions or discussions about contributing to the project
+title: ''
+labels: 'community'
+assignees: ''
+
+---
+
+## Your Inquiry
+
+Describe your question or the discussion topic related to contributing to the project.
+
+### Contribution Proposal
+
+If you have a specific contribution in mind, please describe it here. Include how you believe it will benefit the project.
+
+### Seeking Guidance
+
+If you are looking for guidance on how to start contributing or on specific contribution practices, please detail your needs here.
+
+### Additional Context
+
+Provide any additional context that might help in fostering a productive discussion about community and contributions.

.github/ISSUE_TEMPLATE/documentation.md

@@ -1,9 +1,28 @@
 ---
-name: "Documentation"
-about: Report an issue related to https://albumentations.readthedocs.io#
+name: Documentation Request
+about: Suggest improvements or request additional documentation
+title: ''
+labels: 'documentation'
+assignees: ''
 
 ---
 
-## 📚 Documentation
+## Documentation request
 
-<!-- A clear and concise description of what content in https://albumentations.readthedocs.io is an issue. -->
+Briefly describe the documentation improvement or addition you're suggesting. Clearly state if it's a new document, an addition to existing documentation, or a correction.
+
+### Motivation
+
+Explain why this documentation is necessary. Include any specific challenges or confusion you encountered due to a lack of clear documentation. Mention how this improvement can benefit other users.
+
+### Suggested location
+
+Where do you think this documentation should be located? For example, README.md, the project's official documentation site, docstrings, etc.
+
+### Additional context
+
+Provide any additional information that might help understand your request better, such as links to related issues, discussions, or external resources. If you have seen similar documentation in other projects that you found helpful, feel free to share those examples here.
+
+### Would you be willing to contribute to the documentation?
+
+Let us know if you are interested in helping write this documentation. Your contribution can speed up the process and benefit the entire community.

.github/ISSUE_TEMPLATE/feature-request.md

@@ -0,0 +1,28 @@
+---
+name: Feature Request
+about: Suggest an idea for this project
+title: ''
+labels: 'enhancement'
+assignees: ''
+
+---
+
+## Feature description
+
+Briefly describe the feature you'd like to see added to Albumentations. Explain the problem it solves or the value it adds to the library.
+
+### Motivation and context
+
+Explain why this feature is important and how it fits into the overall objectives of the Albumentations library. Include any relevant links or examples that might help clarify the feature request.
+
+### Possible implementation
+
+Describe how you envision this feature being implemented, if you have ideas. Include considerations for backward compatibility, performance, and how it would integrate with existing functionalities.
+
+### Alternatives
+
+Have you considered any alternative solutions or features? If so, describe them and explain why they were not suitable.
+
+### Additional context
+
+Add any other context, screenshots, sketches, or code snippets about the feature request here. This can include use cases, benchmarks, or other information that would help the development team understand your request better.

.github/ISSUE_TEMPLATE/localization.md

@@ -0,0 +1,24 @@
+---
+name: Localization and Internationalization
+about: Request or suggest adding support for additional languages
+title: ''
+labels: 'localization'
+assignees: ''
+
+---
+
+## Language Requested
+
+Specify the language(s) you are requesting support for.
+
+### Reason for Request
+
+Explain why this language support is important for the project. Include any relevant demographic or user base information.
+
+### Contribution
+
+If you are able to contribute to the localization effort, please let us know here.
+
+### Additional Context
+
+Any other information that might help in understanding the importance of this request.

.github/ISSUE_TEMPLATE/performance.md

@@ -0,0 +1,30 @@
+---
+name: Performance Issue
+about: Report performance issues like slow execution or high memory consumption
+title: ''
+labels: 'performance'
+assignees: ''
+
+---
+
+## Describe the performance issue
+
+A clear and concise description of what the issue is, including specific metrics or observations.
+
+## Reproduction Steps
+
+Please provide a minimal, reproducible example or a sequence of steps that demonstrates the performance issue.
+
+## Expected vs. Actual Behavior
+
+Describe what you expected to happen and how it differs from what you are actually experiencing.
+
+## Environment
+
+- OS:
+- Python version:
+- Albumentations version (or other relevant software versions):
+
+## Additional Context
+
+Any additional information that could help understand and address the issue, such as profiling outputs or benchmarks.

.github/ISSUE_TEMPLATE/question.md

@@ -0,0 +1,24 @@
+---
+name: Question or Clarification
+about: Ask a question or seek clarification about the project
+title: ''
+labels: 'question'
+assignees: ''
+
+---
+
+## Your Question
+
+Describe your question or the clarification you are seeking in detail.
+
+### What have you tried?
+
+Briefly explain what you have tried so far to find an answer to your question. This could include documentation you have read or experiments you have conducted.
+
+### Additional Context
+
+Provide any additional context or screenshots that might help in answering your question.
+
+### Relevant documentation or external resources
+
+If you have consulted any specific documentation or external resources, please list them here.

.github/ISSUE_TEMPLATE/ui.md

@@ -0,0 +1,24 @@
+---
+name: UI/UX Enhancement
+about: Suggest improvements to the user interface and user experience
+title: ''
+labels: 'ui/ux'
+assignees: ''
+
+---
+
+## Enhancement Description
+
+Describe the UI/UX enhancement you suggest. Be as detailed as possible.
+
+### Motivation and Goals
+
+Explain why this enhancement is needed and what goals it aims to achieve. Include any specific problems it solves or improvements it brings.
+
+### Possible Implementation
+
+If you have ideas about how to implement this enhancement, share them here. Include design sketches or mockups if available.
+
+### Additional Context
+
+Provide any additional context or examples of similar enhancements in other projects that might help illustrate your suggestion.

.gitignore

@@ -160,7 +160,6 @@ fabric.properties
 conda_build/
 
 .vscode/
-conda.recipe/
 
 .gitingore
 

.markdownlint.json

@@ -0,0 +1,6 @@
+{
+    "default": true,
+    "MD013": false,
+    "MD033": false,
+    "MD045": false
+}

.pre-commit-config.yaml

@@ -31,8 +31,6 @@ repos:
       - id: destroyed-symlinks
       - id: fix-byte-order-marker
       - id: check-json
-      - id: check-yaml
-        args: [ --unsafe ]
       - id: debug-statements
       - id: end-of-file-fixer
       - id: trailing-whitespace
@@ -66,6 +64,10 @@ repos:
     hooks:
       - id: codespell
         additional_dependencies: ["tomli"]
+  - repo: https://github.com/igorshubovych/markdownlint-cli
+    rev: v0.39.0
+    hooks:
+      - id: markdownlint
   - repo: https://github.com/tox-dev/pyproject-fmt
     rev: "1.7.0"
     hooks:

CONTRIBUTING.md

@@ -27,16 +27,21 @@ cd albumentations
 We recommend using a virtual environment to isolate project dependencies. Ensure you have Python 3.8 or higher installed on your machine, as it is the minimum supported version for Albumentations. To create and activate a virtual environment, run the following commands:
 
 #### Linux / macOS
+
 ```bash
 python3 -m venv env
 source env/bin/activate
 ```
+
 #### Windows cmd.exe
+
 ```bash
 python -m venv env
 env\Scripts\activate.bat
 ```
+
 #### Windows PowerShell
+
 ```bash
 python -m venv env
 env\Scripts\activate.ps1

MANIFEST.in

@@ -1,9 +1,6 @@
 include LICENSE
 include README.md
 
-graft benchmark
-graft tests
-graft docs
 prune docs/_build
 global-exclude docs/augs_overview/*/images/*.jpg
 

README.md

@@ -5,7 +5,7 @@
 [![License: MIT](https://img.shields.io/badge/License-MIT-brightgreen.svg)](https://opensource.org/licenses/MIT)
 [![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
 
-[Discord](https://discord.gg/AKPrrDYNAt) | [Twitter](https://twitter.com/albumentations) | [Docs](https://albumentations.ai/docs/)
+[Docs](https://albumentations.ai/docs/) | [Discord](https://discord.gg/AKPrrDYNAt) | [Twitter](https://twitter.com/albumentations) | [LinkedIn](https://www.linkedin.com/company/100504475/)
 
 Albumentations is a Python library for image augmentation. Image augmentation is used in deep learning and computer vision tasks to increase the quality of trained models. The purpose of image augmentation is to create new training samples from the existing data.
 
@@ -275,7 +275,6 @@ Transforms that mix several images into one
 
 <img src="https://habrastorage.org/webt/e-/6k/z-/e-6kz-fugp2heak3jzns3bc-r8o.jpeg" width=100%>
 
-
 ## Benchmarking results
 
 To run the benchmark yourself, follow the instructions in [benchmark/README.md](https://github.com/albumentations-team/albumentations/blob/master/benchmark/README.md)
@@ -320,7 +319,6 @@ The table shows how many images per second can be processed on a single core; hi
 |GaussianNoise    |64 ± 9                                |-                                           |-                             |67 ± 1                       |**212 ± 16**                  |
 |Elastic          |**129 ± 1**                           |3 ± 1                                       |1 ± 1                         |-                            |128 ± 1                       |
 
-
 ## Contributing
 
 To create a pull request to the repository, follow the documentation at [CONTRIBUTING.md](CONTRIBUTING.md)

benchmark/Dockerfile

@@ -13,4 +13,4 @@ RUN pip install -U --no-cache-dir -r ./benchmark/requirements.txt
 
 WORKDIR /albumentations/benchmark
 
-ENTRYPOINT ["python", "benchmark.py"]
+ENTRYPOINT ["python", "imread_benchmark.py"]

benchmark/README.md

@@ -23,13 +23,13 @@ python benchmark.py --data-dir '/hdd/ILSVRC2012_img_val' --images 2000 --runs 5
 
 ## Running the benchmark in a Docker container
 
-### Build the image, from the root project directory run:
+### Build the image, from the root project directory run
 
 ```bash
 docker build -t albumentations-benchmark -f ./benchmark/Dockerfile .
 ```
 
-### Run the benchmark:
+### Run the benchmark
 
 ```bash
 docker run -v <path to a directory with images on the host machine>:/images albumentations-benchmark <args>

conda.recipe/conda_build_config.yaml

@@ -1,4 +1,6 @@
 python:
-  - 3.5
-  - 3.6
-  - 3.7
+  - 3.8
+  - 3.9
+  - 3.10
+  - 3.11
+  - 3.12