Skip to main content

A toolkit for hierarchical classification

Project description

Classtree

Classtree is a hierarchical classifier for images or text.

pip install classtree

The fastest way to use Classtree is to call the CLI on a folder of images or text files.

train_data/
|- animals/
    |- mammals/
       |- marsupials/
          |- koala/
             |- image001.jpg
             |- image002.jpg
             |- ...
          |- ...
    |- reptiles/
       |- ...
    |- ...
|- ...
classtree train images --model animals --dir train_data/animals

or

classtree train text --model animals --dir train_data/animals

And then use your model with the predict command.

classtree predict --model animals new_data/image304.jpg
> birds/raptors/eagle

Pre-trained Models

You can download a pre-trained model using the download command.

classtree download model dbpedia

Or download a pre-prepared dataset.

classtree download images inaturalist21-mini
classtree download text dbpedia

If you want to fine-tune an existing model, you can use the --from flag during training with any downloaded model.

classtree train text --model animals --from dbpedia --dir train_data/animals

Available Models

Task Name Size Dataset Notes
Image Classification inaturalist21-mini M inaturalist21-mini Non-commercial research/educational use only
Text Classification dbpedia M dbpedia

Available Datasets

Type Name Dataset Notes
Image inaturalist21-mini iNaturalist 2021 (Mini) Non-commercial research/educational use only
Text dbpedia DBPedia CC0: Public Domain

Evaluation

You can test your model on a hold-out dataset using the test command.

classtree test --model animals --dir=test_data/animals

Licensing

Classtree is available for non-commercial internal research use by academic institutions or not-for-profit organisations only, free of charge. Please, see the license for further details. To the extent permitted by applicable law, your use is at your own risk and our liability is limited. Interested in a commercial license? For commercial queries, please email aimlshop@adelaide.edu.au with subject line “Classtree Commercial License”.

This is an AIML Shop project.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

classtree-0.0.2-py3-none-any.whl (30.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page