Skip to main content

A library for text classification using LangChain embeddings and scikit-learn classifiers.

Project description

ClassifAIer

coverage tests test_ratio

ClassifAIer is a Python library that combines scikit-learn classifiers with LangChain embedding libraries, enabling seamless text classification using embeddings from large language models. This library offers a user-friendly interface, allowing you to classify text data in a human-like manner.

Features

  • Embedding Support: Ability to work with embeddings from large language models like OpenAI and compatible with embeddings supported by LangChain.
  • Parametric Classifiers: Compatibility with a wide range of classifiers from scikit-learn (e.g., RandomForestClassifier, KNeighborsClassifier, etc.).
  • Easy to Use: Simplifies text classification tasks with a user-friendly API.
  • Save and Load: Allows you to save and reload trained models for reuse.

Requirements

To use this library, you need Python 3.7 or higher. The required packages will be automatically installed when you install this library.

  • scikit-learn
  • langchain-core
  • langchain
  • numpy

Installation

You can install the required libraries using the following command:

pip install ClassifAIer

Usage

from classifaier import ClassifAIer
from langchain.embeddings import OpenAIEmbeddings
from sklearn.ensemble import RandomForestClassifier

# Initialize the embedding provider
embedding_provider = OpenAIEmbeddings(api_key='YOUR_API_KEY')

random_forest_classifier_params = {
    "n_estimators": 100,
    "max_depth": None,
    "min_samples_split": 2,
    "min_samples_leaf": 1,
    "random_state": 42
}

random_forest_classifier = RandomForestClassifier(**random_forest_classifier_params)

# Create a classifier instance
classifier = ClassifAIer(embedding_provider=embedding_provider, classifier=random_forest_classifier)

# Prepare your data
texts = ["İspanya Birinci Futbol Ligi (La Liga) ekibi Athletic Bilbao, golcü oyuncusu Aritz Aduriz'in sözleşmesini bir yıllığına uzattı.", "Piyasalar ABD'nin enflasyon verilerine odaklandı."]
labels = ["spor", "ekonomi"]

# Train the model
classifier.fit(texts, labels)

# Make predictions
predictions = classifier.predict_all(["Fildişi Sahili Milli Takımı'nın Belçikalı teknik direktörü Marc Wilmots görevinden ayrıldı.", "Borsa, günü yükselişle tamamladı"])
print(predictions)  # Output: ['spor', 'ekonomi']

# Save the model
classifier.save("my_classifier.pkl")

# Load the model
loaded_classifier = ClassifAIer.load("my_classifier.pkl", embedding_provider)

Contributing

Contributions are welcome! If you have suggestions or improvements, please create a pull request or open an issue.

License

This project is licensed under the MIT License. See the LICENSE file for details.

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

ClassifAIer-0.1.6.tar.gz (6.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

ClassifAIer-0.1.6-py3-none-any.whl (7.0 kB view details)

Uploaded Python 3

File details

Details for the file ClassifAIer-0.1.6.tar.gz.

File metadata

  • Download URL: ClassifAIer-0.1.6.tar.gz
  • Upload date:
  • Size: 6.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.17

File hashes

Hashes for ClassifAIer-0.1.6.tar.gz
Algorithm Hash digest
SHA256 30ee36a9972aba9297070b5b05c8bfe6f21e77556e3d981da1d7ea43f2b79707
MD5 438f0967731f2c7d41ee76237158821a
BLAKE2b-256 5fe22d8e681ce52bcf32ae07594271aaed4441c7503741b47ce3dd71099e0fae

See more details on using hashes here.

File details

Details for the file ClassifAIer-0.1.6-py3-none-any.whl.

File metadata

  • Download URL: ClassifAIer-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 7.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.17

File hashes

Hashes for ClassifAIer-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 122df3c4e0a8a489131307b57b6393180048ec9e05ff7304c8b38b0c411e841d
MD5 0a581f1dd6c299f5fbe311b44e702f5d
BLAKE2b-256 3600337ec3a7267f6749fe5c6a65a347d0049b43ce562b188dfcdd1de1961f89

See more details on using hashes here.

Supported by

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