Python package for the Nyckel API

Navigation

Verified details

These details have been verified by PyPI
Maintainers
Avatar for oscarbeijbom from gravatar.com oscarbeijbom

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: MIT License
  • Author: Oscar Beijbom
  • Requires: Python >=3.8
Classifiers

Project description

Nyckel

Python package for www.nyckel.com

build test docs PyPi version

Docs

Visit our Docs pages

Quickstart

from nyckel import Credentials, TextClassificationFunction

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

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

# Provide a few examples.
func.create_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.
predictions = func.invoke(["New text"])

Contributors

Setup dev environment

pip install -r requirements.txt

Building docs locally

Install additional packages

pip install -r docs/requirements.txt

Run

mkdocs build

Testing

Testing locally requires a local server running the API. CI will run tests against a staging environment.

Supported by

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