Skip to main content

Python package for the Nyckel API

Project description

Nyckel

Python package for www.nyckel.com

build test docs PyPi version

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.

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nyckel-0.1.3.tar.gz (132.3 kB view hashes)

Uploaded Source

Built Distribution

nyckel-0.1.3-py3-none-any.whl (26.1 kB view hashes)

Uploaded Python 3

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