Skip to main content

This library has two purposes: 1. allow to easily test semantic classification with open labels (not pre defined) for intent recognition. 2. allow to experiment with different n-shot classification components.

Project description

Open Intent Classification

Closed intent classification uses a set of predefined labels to identify an intent. In comparison, open intent classification allows you to define as many labels you want, without fine tuning the model.

This project implements different components that support open intent classification such as an embedder, a T5 based fine tuned model for intent classification and a verbalizer. If you are interested in finer detailes you can read my blog post.

The goal of this library is to enable you test your assumptions about your data as fast as possible and to be a one stop shop for everything "classification like", similarly to how Bertopic is for clustering.

Why should you use this?

  1. You are researching nlp classification problems and want to test different embeddings, verbalizers and components with plug-and-play feel
  2. You want to detect semantically user intents in text but either don't want to commit to pre-defined classes OR just want to test out the fastest way to classify text other than through an LLM

[!IMPORTANT]

open-intent-classification project is in Alpha stage.

  1. Expect API changes
  2. Milage may vary. Quality of classifiers have been tested on Atis and Banking77

Usage

A full example is under Atis Notebook

T5 Based Intent Classification

from open_intent_classifier.model import IntentClassifier
model = IntentClassifier()
labels = ["Cancel Subscription", "Refund Requests", "Broken Item", "And More..."]
text = "I don't want to continue this subscription"
predicted_label = model.predict(text, labels)

By default, the IntentClassifier is loading a small model with 80M parameters.

For higher accuracy you can initialize the model with:

from open_intent_classifier.model import IntentClassifier
from open_intent_classifier.consts import INTENT_CLASSIFIER_248M_FLAN_T5_BASE
model = IntentClassifier(INTENT_CLASSIFIER_248M_FLAN_T5_BASE)

This will increase model latency as well.

Embeddings Based Classification

from open_intent_classifier.embedder import StaticLabelsEmbeddingClassifier
labels = ["Cancel Subscription", "Refund Requests", "Broken Item", "And More..."]
text = "I don't want to continue this subscription"
embeddings_classifier = StaticLabelsEmbeddingClassifier(labels)
predicted_label = embeddings_classifier.predict(text)

Training the T5 base classifier

The details of training of the classifier is in another repository. I have separated training from inference in order to allow each repository to be focused and extended.

You can read about the training in the training repo: https://github.com/SerjSmor/intent_classification

Roadmap

  • Add LLM based classification
  • Add an option to ensemble embeddings and T5 (and additional models)
  • Create a recommender for fine-tuning

Project details


Download files

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

Source Distribution

open_intent_classifier-0.0.3.tar.gz (5.9 kB view details)

Uploaded Source

Built Distribution

open_intent_classifier-0.0.3-py3-none-any.whl (5.9 kB view details)

Uploaded Python 3

File details

Details for the file open_intent_classifier-0.0.3.tar.gz.

File metadata

File hashes

Hashes for open_intent_classifier-0.0.3.tar.gz
Algorithm Hash digest
SHA256 d4027c2c59c4321cfdc382efb4058e080cb084796fe7e1e0a47d71a5c1947f80
MD5 a7fd181f954e92ecf50c71a51d6d78b2
BLAKE2b-256 43404a69c8e5c0daafa72d91b233956a06860e7aa20df31f6ca8f65d5708a850

See more details on using hashes here.

File details

Details for the file open_intent_classifier-0.0.3-py3-none-any.whl.

File metadata

File hashes

Hashes for open_intent_classifier-0.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 69e080b87b7155008380b2bd4798def6b7c9f72df01fa7d0629ae2626f0b217f
MD5 cfca4b940797e408632658e78501c6a7
BLAKE2b-256 181b2cf3fbf9f6435084b802a0be3508c61ca1568bd353fc4538f2c7a1375bce

See more details on using hashes here.

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