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

Create a python3.11 venv and run:

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.

  1. Ensure the local server is running
  2. Ensure the nyckel package is installed in the venv using pip install -e .
  3. Run pytest from the root directory

Deploying

One time

  1. pip install hatch

Each time

hatch publish

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for oscarbeijbom from gravatar.com oscarbeijbom

Credits

Author: Oscar Beijbom

License

MIT License

Requires

Python >=3.8

Classifiers

Report project as malware

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.23.tar.gz (194.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nyckel-0.4.23-py3-none-any.whl (37.4 kB view details)

Uploaded Python 3

File details

Details for the file nyckel-0.4.23.tar.gz.

File metadata

  • Download URL: nyckel-0.4.23.tar.gz
  • Upload date:
  • Size: 194.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.24

File hashes

Hashes for nyckel-0.4.23.tar.gz
Algorithm Hash digest
SHA256 d257255355b1dfc5248195ea0592923cf054d71ab840ce0d35e5df4d4a218fb5
MD5 0824162539006580e32fa3e8d8a0117d
BLAKE2b-256 b495f9c3fa62c3b05230e43d1aad7bafb5ccea7de25f5f5083e89dda0fa0749b

See more details on using hashes here.

File details

Details for the file nyckel-0.4.23-py3-none-any.whl.

File metadata

  • Download URL: nyckel-0.4.23-py3-none-any.whl
  • Upload date:
  • Size: 37.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.24

File hashes

Hashes for nyckel-0.4.23-py3-none-any.whl
Algorithm Hash digest
SHA256 422bd0f9760ce70f6994526d5b838258167cbc9cd6b49dd07524ff72b57315d1
MD5 0abd7462dbd1ee04aef28d8548e2b6ab
BLAKE2b-256 5c49806a2a28efc86b4c17ab626454aa513e6b520baf6eed354f20b124170ffb

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.4.23 This release

2 files

0.4.22

2 files

0.4.21

2 files

0.4.20

2 files

0.4.19

2 files

0.4.18

2 files

0.4.17

2 files

0.4.16

2 files

0.4.15

2 files

0.4.14

2 files

0.4.13

2 files

0.4.12

2 files

0.4.11

2 files

0.4.10

2 files

0.4.8

2 files

0.4.7

2 files

0.4.6

2 files

0.4.5

2 files

Yanked

0.4.4

2 files

Yanked reason: Tabular invoke broken -- please use a different version.

0.4.3

2 files

0.4.2

2 files

0.4.1

2 files

0.4.0

2 files

0.3.4

2 files

0.3.3

2 files

0.3.2

2 files

0.3.1

2 files

0.3.0

2 files

0.2.13

2 files

0.2.12

2 files

0.2.11

2 files

0.2.10

2 files

0.2.9

2 files

0.2.8

2 files

0.2.7

2 files

0.2.6

2 files

0.2.5

2 files

0.2.4

2 files

0.2.3

2 files

0.2.2

2 files

0.2.1

2 files

0.2.0

2 files

0.1.9

2 files

0.1.8

2 files

0.1.7

2 files

0.1.6

2 files

0.1.5

2 files

0.1.4

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

0.0.58

2 files

0.0.57

2 files

0.0.56

2 files

0.0.55

2 files

0.0.54

2 files

0.0.53

2 files

0.0.52

2 files

0.0.51

2 files

0.0.50

2 files

0.0.49

2 files

0.0.48

2 files

0.0.46

2 files

0.0.45

2 files

0.0.44

2 files

0.0.43

2 files

0.0.42

2 files

0.0.41

2 files

0.0.40

2 files

0.0.39

2 files

0.0.38

2 files

0.0.37

2 files

0.0.36

2 files

0.0.34

2 files

0.0.33

2 files

0.0.32

2 files

0.0.31

2 files

0.0.30

2 files

0.0.29

2 files

0.0.28

2 files

0.0.27

2 files

0.0.26

2 files

0.0.25

2 files

0.0.24

2 files

0.0.22

2 files

0.0.21

2 files

0.0.20

2 files

0.0.19

2 files

0.0.18

2 files

0.0.17

2 files

0.0.16

2 files

0.0.15

2 files

0.0.13

2 files

0.0.12

2 files

0.0.11

2 files

0.0.10

2 files

0.0.9

2 files

0.0.8

2 files

0.0.7

2 files

0.0.6

2 files

0.0.5

2 files

0.0.4

2 files

0.0.3

2 files

0.0.2

2 files

0.0.1

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page