Python package for the Nyckel API
Project description
Nyckel
Python package for www.nyckel.com
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.
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.4.17.tar.gz
(192.6 kB
view details)
Built Distribution
nyckel-0.4.17-py3-none-any.whl
(36.1 kB
view details)
File details
Details for the file nyckel-0.4.17.tar.gz
.
File metadata
- Download URL: nyckel-0.4.17.tar.gz
- Upload date:
- Size: 192.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.9.20
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 52df543df1f71215013a244e95057a03d7e66ca4f874d9b885f47be73cd313b9 |
|
MD5 | 961e7d245fb1353d463da49f4d2a34f8 |
|
BLAKE2b-256 | 24e7229d56de8990aa0b1f2eac0a92a0e93c25886cade5cc1fd7171651bff0e3 |
File details
Details for the file nyckel-0.4.17-py3-none-any.whl
.
File metadata
- Download URL: nyckel-0.4.17-py3-none-any.whl
- Upload date:
- Size: 36.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.9.20
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 19835eefbb94fd36e4d650cb576240e5c0b184a62de610add839bd8557c5216d |
|
MD5 | 6cb9a239423828b9f0eed3c12cc191b7 |
|
BLAKE2b-256 | 655c6ed424e055cbede0631b44a1910eb994aab2311a92782d4dc3a30f908fad |