https://github.com/albumentations-team/albumentations-ai-docs
Markdown documentation that is used at the Albumentations.ai website
https://github.com/albumentations-team/albumentations-ai-docs
Science Score: 26.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (11.7%) to scientific vocabulary
Keywords
Repository
Markdown documentation that is used at the Albumentations.ai website
Basic Info
- Host: GitHub
- Owner: albumentations-team
- Language: Python
- Default Branch: main
- Homepage: https://albumentations.ai
- Size: 3.03 MB
Statistics
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
- Releases: 0
Topics
Metadata Files
README.md
Albumentations AI Documentation Source
This repository contains the source Markdown files used to generate the documentation website for Albumentations AI, available at:
https://albumentations.ai/docs/
Contribution
We welcome contributions to the documentation! To ensure consistency and quality, please adhere to the following guidelines when editing or adding content.
Conventions
Markdown files in this repository follow specific conventions enforced by pre-commit hooks:
- File Naming: All Markdown filenames (
.md) must use hyphens (-) instead of underscores (_). - Directory Naming: All directory names within the
docs/path must use hyphens (-) instead of underscores (_). - Relative Links: Relative links (to other
.mdfiles or directories within this repository) must use hyphens (-) instead of underscores (_) in their paths. Underscores are allowed in link text ([link_text]) and in links to external websites or anchors (#section_header). - Image Links:
- Relative image links are allowed to contain underscores in their paths.
- All relative image links must point to files with the
.webpextension.
Pre-commit Hooks
This repository uses pre-commit to automatically check and enforce coding standards and the Markdown conventions listed above.
Setup:
- Install
pre-commit:pip install pre-commit(orpip install -r requirements-dev.txtif you have cloned the repo and activated a virtual environment). - Install the git hooks:
pre-commit install
Now, the hooks will run automatically on git commit.
Running Hooks Manually:
You can run the checks on all files at any time:
bash
pre-commit run --all-files
Autofixing:
The Markdown convention hook is configured to automatically fix underscores in relative link paths. If the hook modifies files, simply git add the changes and commit again.
Website Generation
(Information about the tool or process used to convert these Markdown files into the website https://albumentations.ai/docs/ can be added here.)
Owner
- Name: Albumentations.AI
- Login: albumentations-team
- Kind: organization
- Location: United States of America
- Website: https://albumentations.ai/
- Twitter: albumentations
- Repositories: 12
- Profile: https://github.com/albumentations-team
Fast and flexible image augmentation library for computer vision tasks. Albumentations helps researchers improve models with diverse training data.
GitHub Events
Total
- Watch event: 1
- Delete event: 15
- Issue comment event: 16
- Push event: 26
- Pull request review event: 29
- Pull request review comment event: 21
- Pull request event: 27
- Fork event: 1
- Create event: 19
Last Year
- Watch event: 1
- Delete event: 15
- Issue comment event: 16
- Push event: 26
- Pull request review event: 29
- Pull request review comment event: 21
- Pull request event: 27
- Fork event: 1
- Create event: 19
Issues and Pull Requests
Last synced: 7 months ago
Dependencies
- actions/cache v4 composite
- actions/checkout v4 composite
- actions/setup-python v5 composite
- pre-commit * development
- pytest * development