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)

LLM Based Classification

Using LLM for classification is a viable option that sometimes provides the highest quality. Currently we have implemented Open AI based LLMs.

from open_intent_classifier.model import OpenAiIntentClassifier
labels = ["Cancel Subscription", "Refund Requests", "Broken Item", "And More..."]
text = "I don't want to continue this subscription"
model_name = "gpt-4o-mini"
classifier = OpenAiIntentClassifier(model_name)
result = classifier.predict(text=text, labels=labels)

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 embeddings filtering stage for classifiers
  • Add small language models as classifiers
  • Add multithreading for LLM based classifiers
  • 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.5.tar.gz (6.5 kB view details)

Uploaded Source

Built Distribution

open_intent_classifier-0.0.5-py3-none-any.whl (6.5 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for open_intent_classifier-0.0.5.tar.gz
Algorithm Hash digest
SHA256 7091ffc48aadbb753fcb245590ed50ad0a4076b8b968badb890cb6a515feca26
MD5 2031166aea10dfcc96b5d39740050fa6
BLAKE2b-256 12bd6255271e482cc5cbd567e8b6b5c63c3b9bc526fabeff311adffb818e783c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for open_intent_classifier-0.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 03f953d6a8a4bb2aa46b8dc0f9886496e21bfbf624807a6071325c243d29c6e6
MD5 8609c36f107e9c556370cd64929c17b8
BLAKE2b-256 b2c014725f7d0eba2d923913079fee09310a98130e2e9ba0b97e6eadfc5d2e6f

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