nyckel 0.1.3

Python package for the Nyckel API

Nyckel

Python package for www.nyckel.com

Docs

Visit our Docs pages

Quickstart

from nyckel import User, TextClassificationFunction

# Get credentials from https://www.nyckel.com/console/keys
user = User(client_id=..., client_secret=...)

# Create a new text classification function.
func = TextClassificationFunction.new(user=user, name="IsToxic")

# Provide a few examples.
func.add_samples([
    ("This is a nice comment", "not toxic"),
    ("Hello friend", "not toxic"),
    ("This is a bad comment", "toxic"),
    ("Who is this? Go away!", "toxic"),
])

# Nyckel trains and deploys your model in a few seconds...
# ...and you can start classifying text right away!

# Classify a new piece of text.
label = func("New text")

Contributors

Setup dev environment

pip install -r requirements.txt

Building docs locally

Install packages

mkdocs==1.5.3
mkdocs-material==9.4.5
mkdocstrings==0.15.0

Run

mkdocs build

Note that the actual docs uses an private repo that allows cross-references for types.