Use microclassifiers in the cloud for spam detection, sentiment analysis and more.
- Node.js 14 or newer
The Classr SDK for Node.js can be installed using npm
:
npm install classr --save
Initiaize your microclassifier by passing its UUID to the Classr
constructor like so:
import { Classr } from 'classr'
// Initialize cloud microclassifier.
const classifier = new Classr('acd78708-850b-4cea-aeaa-23cec50d13b6');
Now, call the classify
or getInfo
functions of classifier
to make use of it:
// Classify unseen input.
const document = 'The unseen document you want to classify!';
console.log(`Predicted class: ${await classifier.classify(document)}`);
// Print macro F1 score of classifier.
const info = await classifier.get_info()
console.log(`Classifier macro F1 score is: ${await info.f1_score}`);
If you'd like to use a self-hosted deployment of the Classr application (i.e. not the default official API), you can
pass a different base URL when constructing your Classr
object:
import { Classr } from 'classr'
// Initialize cloud microclassifier.
const classifier = new Classr('acd78708-850b-4cea-aeaa-23cec50d13b6', 'https://self-hosted-classr.example.com/');
This SDK is for the official Classr application (but will work with a self-hosted deployment too, of course).