Skip to main content

Run prediction functions locally in Python. Register at https://fxn.ai.

Project description

Function for Python

function logo

Dynamic JSON Badge

Run prediction functions (a.k.a "predictors") locally in your Python apps, with full GPU acceleration and zero dependencies.

[!TIP] Join our waitlist to bring your custom Python functions and run them on-device across Android, iOS, macOS, Linux, web, and Windows.

Installing Function

Function is distributed on PyPi. This distribution contains both the Python client and the command line interface (CLI). To install, open a terminal and run the following command:

# Install Function
$ pip install --upgrade fxn

[!NOTE] Function requires Python 3.10+

Retrieving your Access Key

Head over to fxn.ai to create an account by logging in. Once you do, generate an access key:

generate access key

Making a Prediction

First, create a Function client, specifying your access key:

from fxn import Function

# Create the Function client
fxn = Function(access_key="<Function access key>")

Then make a prediction:

# Create a prediction
prediction = fxn.predictions.create(
    tag="@fxn/greeting",
    inputs={ "name": "Peter" }
)
# Print the returned greeting
print(prediction.results[0])

Using the Function CLI

Open up a terminal and login to the Function CLI:

# Login to Function
$ fxn auth login <ACCESS KEY>

Then make a prediction:

# Make a prediction using the Function CLI
$ fxn predict @fxn/greeting --name Peter

Useful Links

Function is a product of NatML Inc.

Project details


Download files

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

Source Distribution

fxn-0.0.50.tar.gz (825.8 kB view details)

Uploaded Source

Built Distribution

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

fxn-0.0.50-py3-none-any.whl (834.3 kB view details)

Uploaded Python 3

File details

Details for the file fxn-0.0.50.tar.gz.

File metadata

  • Download URL: fxn-0.0.50.tar.gz
  • Upload date:
  • Size: 825.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.12

File hashes

Hashes for fxn-0.0.50.tar.gz
Algorithm Hash digest
SHA256 594954840f05050168b4fc0b21bc27be7aaa260206dfeca94d67faa3cbf79841
MD5 0866a2e641fbf32203be2e7c3ab9640b
BLAKE2b-256 dcbcc3ed4ff21fea51b0724536d898ee5514072c44d81d13568e3bdd4dbfa8b1

See more details on using hashes here.

File details

Details for the file fxn-0.0.50-py3-none-any.whl.

File metadata

  • Download URL: fxn-0.0.50-py3-none-any.whl
  • Upload date:
  • Size: 834.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.12

File hashes

Hashes for fxn-0.0.50-py3-none-any.whl
Algorithm Hash digest
SHA256 34eaf71207651b507805e003df04c6ce2a52739ec570b966a37c80dec3521e0d
MD5 0c0e922f76e161638f625f512b61a2c8
BLAKE2b-256 4eeeb4d468d409edb30efd9d1c9288baea53cfd621e1068e8702494532037f0e

See more details on using hashes here.

Supported by

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