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.4.tar.gz (6.0 kB view details)

Uploaded Source

Built Distribution

open_intent_classifier-0.0.4-py3-none-any.whl (6.1 kB view details)

Uploaded Python 3

File details

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

File metadata

File hashes

Hashes for open_intent_classifier-0.0.4.tar.gz
Algorithm Hash digest
SHA256 3013cfcd92cf7a9b314903643bfe28ebc50ea5daacad0ceb9ae9e0a2ed4d4a6f
MD5 6d817889c7d9539ff0c73ca18ad8694c
BLAKE2b-256 dca4a66b25f33a1aa527f9bb2e2549df89757d37ec16735b01663ac7c65611d8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for open_intent_classifier-0.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 392b7d381738612779b820809b23c7b45c7403ef83b5464e0af537a33311b226
MD5 090a61ab42932028c77b85ac179e5604
BLAKE2b-256 b98df137679c8334dffd124395ed9758353a603d42e3ffbaf4fb7d57557b6e14

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