Skip to content
mazharulrobeenPublic

About

Preview how your bonsai could be styled before you cut. Upload a photo, confirm the species, and see your own tree in styles like windswept, cascade, and informal upright. Open source.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

Katachi (形)

Status: early development (v0.1 in progress). Nothing here is usable yet.

Katachi is an open source tool for bonsai hobbyists. Upload a photo of your tree to see its species, sourced bonsai care practices, and which styles (Informal upright (Moyogi), Slanting (Shakan), Windswept (Fukinagashi)) suit it.

Planned features (v0.1)

  • Photo upload with built-in sample photos and friendly validation
  • Automatic background removal (tree and pot)
  • Tree Profile card: predicted species with confidence, care practices from sourced species files, suitable styles, and a rough structure estimate, with a manual species override

Quick start (development)

Requires Python 3.11+.

python -m venv .venv && source .venv/bin/activate
pip install -e ".[segment,dev]"
pytest && ruff check .
python -m katachi.pipeline --image path/to/tree.jpg   # saves the isolated tree + pot

Background removal downloads the U2-Net model (~170 MB) on first use.

Contributing

Species data is the easiest place to help. Contribution guides are coming soon in CONTRIBUTING.md and docs/.

License

Apache-2.0. See LICENSE. Third-party models and their licenses are listed in MODEL_LICENSES.md.

About

Preview how your bonsai could be styled before you cut. Upload a photo, confirm the species, and see your own tree in styles like windswept, cascade, and informal upright. Open source.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages