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.55.tar.gz (830.7 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.55-py3-none-any.whl (841.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: fxn-0.0.55.tar.gz
  • Upload date:
  • Size: 830.7 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.55.tar.gz
Algorithm Hash digest
SHA256 9d3d5277caf2df19ee2b4d96dd73b90810ac5ff1998d5d640c3c54d21a6b1934
MD5 fea8345bdc55855b17ccda02f43f55d7
BLAKE2b-256 2b9d5ceee0ea691ea3d22822211b455dd61e0e542a8472ef652e7553bea71215

See more details on using hashes here.

File details

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

File metadata

  • Download URL: fxn-0.0.55-py3-none-any.whl
  • Upload date:
  • Size: 841.0 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.55-py3-none-any.whl
Algorithm Hash digest
SHA256 1b9d18573838f72816edd61fbacda294919e50a4a74404e0e04879c61b722366
MD5 1c5ced03ae0743b21d1fd9a1017ca764
BLAKE2b-256 766d1738ba54a967c005b1548b285da8e064d707de5f8b3e8ec2039321b88844

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