Skip to main content

treespec

pypi-image License: MIT CI coverage PyPI - Python Version

A deeplearning pipeline to classify tree species in terrestrial panorama pictures.

About

treespec is a PyTorch-lightning based deep learning pipeline equipped with tools helpfull for creating datasets from images, 3D point clouds and shapefile data containing inventory information.

Features:

  • match tree inventories
  • create masked datasets
  • train standard torchvision models

Installation

Method 1: Docker Container

Download the current treespec container on Docker Hub (Docker required).

docker pull vogelingmar/treespec:latest

Run the container with docker run and mount folders you want to work with.

docker run -it --gpus all -v *local_path*:/workspace/data vogelingmar/treespec

Method 2: GitHub Repository

Clone the treespec repository from GitHub (Git required).

When first setting up treespec you have to have Python3 installed on your system. To create a virtual environment and install all the required dependecies to run the treespec pipeline follow these steps:

  1. Navigate into your local treespec repo.
cd treespec/
  1. Run the setup script.
bash setup.sh

Usage

  1. Activate the virtual environment created by setup.sh.
. venv/bin/activate
  1. Run the pytest tests to check if everything works.
pip install -e .[dev]; pytest test
  1. Configure the settings of the scripts (src/treespec/scripts) in the src/conf/config.yaml file (see config.py/ config_parser.py for available options).
nano src/conf/config.yaml
  1. Run any script (example: train.py).
python src/scripts/train.py

Now you should see the training progress in your terminal, along with some metrics. In the end you can see some statistics and the trained model is saved to src/io/models.

If you want to look further into the training statistics run this command and follow its instructions.

tensorboard --logdir=lightning_logs/
  1. For further help you can build the documentation.
pip install -e .[docs]; cd docs; make html

You can now find the generated html files in docs/_build/html.

Metadata

Release files for treespec 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for treespec 0.1.0
File Size Uploaded
treespec-0.1.0.tar.gz 19.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for treespec 0.1.0
File Interpreter ABI Platform
treespec-0.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 41.5 kB

Release files / treespec-0.1.0.tar.gz

Download URL treespec-0.1.0.tar.gz
Size 19.8 kB
Tags Source
SHA-256 checksum
How to use checksums
ebbf8868367f1a01aad71954e0b8f737e17cc300002669e3c35f5dff5002bc9a
BLAKE2b-256 checksum
How to use checksums
8f7305c763cb2ca578da1bbca3e1a171318c46ac361ec8af6df61f2ea76af916
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.3

Release files / treespec-0.1.0-py3-none-any.whl

Download URL treespec-0.1.0-py3-none-any.whl
Size 21.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
258e6e4a08e633993594412f8319b6374d529e15090dc0f605c1f2d42fe4b260
BLAKE2b-256 checksum
How to use checksums
5e633a460e8686e36ca254ac65fcfeafad9d9bdda2dfcc2ff469fc3e9319087e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.3

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page