Skip to main content

Skafos Python SDK

Build Status

Skafos is the platform for automating the delivery of machine learning models to mobile devices. We provide this SDK as a Python wrapper for uploading, fetching, and listing model versions from the platform.

If you're a Data Scientist or Machine Learning Engineer, you're the one entrusted with building robust machine learning models. This SDK is an interface to the Skafos platform, allowing you to do the following from your Python development environment:

  • Upload a model version: Save a new version of your machine learning model to the Skafos platform, making it available for mobile delivery.
  • Deploy a model version: Deliver a saved model version to your mobile application over-the-air.
  • Fetch a model version: Download a previously saved version of your machine learning model from the Skafos platform.
  • List model versions: For each of your apps and models, see what model versions you have previously saved to the Skafos platform.

Supported Platforms

Operating Systems

This is not an exhaustive list of OS that are compatible with skafos. These are the one's we've explicitly tested:

  • macOS 10.12+
  • Linux (Ubuntu 16.0.4+)

Cloud Platforms

  • Google Colab + Google Cloud
  • IBM Watson
  • AWS Sagemaker
  • Microsoft Azure

System Requirements

  • Python 3+
  • Pip (to download skafos from the Python Package Index)

Installation

You can install skafos directly from the Python Package Index (PyPI).

pip install -U skafos

Once you've installed skafos, you can import the package in your Python environment.

import skafos
skafos.get_version() # returns the current SDK version

For more details on installation and usage, see the package documentation.

Documentation

Example: Uploading a Model Version

import os
from skafos import models

# Set your API Token first for repeated use
os.environ["SKAFOS_API_TOKEN"] = "<YOUR-SKAFOS-API-TOKEN>"

# You can retrieve this info with skafos.summary()
org_name = "<YOUR-SKAFOS-ORG-NAME>"    # Example: "mike-gmail-com-467h2"
app_name = "<YOUR-SKAFOS-APP-NAME>"    # Example: "Recommender-App"
model_name = "<YOUR-MODEL-NAME>"       # Example: "RecommenderModel"

# Upload model version to Skafos
model_upload_result = models.upload_version(
    files="<path(s)-to-model-file(s)>", # Example: ["../my_recommender_model.mlmodel"]
    org_name=org_name,
    app_name=app_name,
    model_name=model_name
)

Need Help?

Didn't find something you need? Confused by something? Need more guidance?

Please contact us with questions or feedback! Here are two ways:

Metadata

Release files for skafos 0.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for skafos 0.3.0
File Size Uploaded Provenance Actions
skafos-0.3.0.tar.gz 11.5 kB Without provenance Details for skafos-0.3.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for skafos 0.3.0
File Interpreter ABI Platform Actions
skafos-0.3.0-py3-none-any.whl Python 3 none any Details for skafos-0.3.0-py3-none-any.whl

Total release size: 26.8 kB

Release files / skafos-0.3.0.tar.gz

Download URL skafos-0.3.0.tar.gz
Size 11.5 kB
Tags Source
SHA-256 checksum
How to use checksums
4eb18fd8dcfe9c855ccbbe2982f416b5c0744497aee63cc9dae2b84ea3170f82
BLAKE2b-256 checksum
How to use checksums
b9b608784ba5d0771c3a462e57516bd112e2ebb1b07782663d001aa70a2ed121
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.3

Release files / skafos-0.3.0-py3-none-any.whl

Download URL skafos-0.3.0-py3-none-any.whl
Size 15.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
7e7ca1e81cf2af82c12c4a4fac6c2fff305e4be31a602ab839dbcfa13c9a6bd2
BLAKE2b-256 checksum
How to use checksums
398e7114540b303e92b7f35191be02f3aaed1f515fafa11c7481f8ab46cc7b1e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.32.1 CPython/3.7.3

Security for skafos 0.3.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

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