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.54.tar.gz (830.1 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.54-py3-none-any.whl (840.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for fxn-0.0.54.tar.gz
Algorithm Hash digest
SHA256 8ad6ce8e456665096388eb4211154b15cdb82ae612e45741729d633c308ed959
MD5 6cfb1b6b40792a0fa7772c46ff31a3b3
BLAKE2b-256 73c2f61c2f29d43cb8be01cab837f52e3033dc7e4b0d9053093a2803e49ea3f2

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for fxn-0.0.54-py3-none-any.whl
Algorithm Hash digest
SHA256 a228220bdf7a4aa1f9df93962d9d0a6ac3a3a4587c72fda38250ed816d8d18e8
MD5 70ee11c2567dcd310bacfb8aaf53c459
BLAKE2b-256 f8a4e041b3c9f1120e4f9bd951c25ccf13a6a5684cc476b26a4ccb49c96f576c

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