Skip to content

Commit

Permalink
Merge branch 'main' into numpy_bboxes_2
Browse files Browse the repository at this point in the history
  • Loading branch information
Dipet committed Mar 24, 2024
2 parents f53aa6d + d13efeb commit e68a597
Show file tree
Hide file tree
Showing 38 changed files with 1,647 additions and 892 deletions.
39 changes: 20 additions & 19 deletions .github/ISSUE_TEMPLATE/bug-report.md
Original file line number Diff line number Diff line change
@@ -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.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/code-quality.md
Original file line number Diff line number Diff line change
@@ -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.
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/community.md
Original file line number Diff line number Diff line change
@@ -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.
27 changes: 23 additions & 4 deletions .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -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.
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.md
Original file line number Diff line number Diff line change
@@ -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.
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/localization.md
Original file line number Diff line number Diff line change
@@ -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.
30 changes: 30 additions & 0 deletions .github/ISSUE_TEMPLATE/performance.md
Original file line number Diff line number Diff line change
@@ -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.
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -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.
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/ui.md
Original file line number Diff line number Diff line change
@@ -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.
5 changes: 1 addition & 4 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,5 @@
name: CI
on:
push:
branches:
- main
pull_request:
branches:
- main
Expand All @@ -15,7 +12,7 @@ jobs:
matrix:
operating-system: [ubuntu-latest, windows-latest, macos-latest]
python-version: [3.8, 3.9, "3.10", "3.11", "3.12"]
fail-fast: false
fail-fast: true
steps:
- name: Checkout
uses: actions/checkout@v4
Expand Down
8 changes: 4 additions & 4 deletions .github/workflows/upload_to_pypi.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ jobs:
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install setuptools wheel twine
pip install build twine
- name: Build and publish
env:
TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
TWINE_USERNAME: __token__
TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
run: |
python setup.py sdist bdist_wheel
python -m build
twine upload dist/*
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,6 @@ fabric.properties
conda_build/

.vscode/
conda.recipe/

.gitingore

Expand Down
6 changes: 6 additions & 0 deletions .markdownlint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"default": true,
"MD013": false,
"MD033": false,
"MD045": false
}
14 changes: 10 additions & 4 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -46,7 +44,7 @@ repos:
types: [python]
- repo: https://github.com/astral-sh/ruff-pre-commit
# Ruff version.
rev: v0.3.2
rev: v0.3.3
hooks:
# Run the linter.
- id: ruff
Expand All @@ -66,11 +64,19 @@ 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:
- id: pyproject-fmt
- repo: https://github.com/pre-commit/mirrors-mypy
rev: v1.9.0
hooks:
- id: mypy
files: ^albumentations/
additional_dependencies: [ types-PyYAML]
additional_dependencies: [ types-PyYAML, types-setuptools]
args:
[ --config-file=pyproject.toml ]
Loading

0 comments on commit e68a597

Please sign in to comment.