Skip to main content

Command line tool to create model bundles for Liquid Edge AI Platform (LEAP)

Project description

leap-bundle

Command line tool to create model bundles for Liquid Edge AI Platform (LEAP).

This tool enables everyone to create, manage, and download AI model bundles for deployment on edge devices. Upload your model directories, track bundle creation progress, and download optimized bundles ready for mobile integration.

See the documentation for more details.

Installation

pip install leap-bundle

Quick Start

Authenticate

  1. Sign in on the LEAP website
  2. Click the account icon on the top right, and go to your profile
  3. Select the API keys tab and create a new API key
  4. Authenticate the Model Bundling Service with your API token:
leap-bundle login <api-key>

Example output:

 Validating API token...
✓ Successfully logged in to LEAP platform!

Create model bundle

  1. Prepare your model checkpoint.
  2. Create a bundle request:
leap-bundle create <path-to-your-model-checkpoint>

Example output:

 Calculating directory hash...
ℹ Submitting bundle request...
✓ Bundle request created with ID: 1 Starting upload...
Uploading directory... ✓
✓ Upload completed successfully! Request ID: 1
  1. Check request status:
leap-bundle list

Example output:

Bundle Requests (50 most recent)
┏━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┓
┃ ID    Input Path                       Status        Creation                Notes                       ┃
┡━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┩
│ 1     /path/to/your/model/directory    processing    2024-01-15T10:30:00Z    Request is being processed. │
└──────┴─────────────────────────────────┴──────────────┴────────────────────────┴─────────────────────────────┘
✓ Found 1 bundle requests.

Get details for a specific request:

leap-bundle list <request-id>

Example output:

 Request Details:
  ID:         1
  Input Path: /path/to/your/model/directory
  Status:     completed
  Creation:   2024-01-15T10:30:00Z
  Update:     2024-01-15T10:45:00Z
  Notes:
  1. When the request is Completed, you can download the bundle:
leap-bundle download <request-id>

Example output:

 Requesting download for bundle request 1...
✓ Download URL obtained for request 1
Downloading bundle output... ✓
✓ Download completed successfully! File saved to: input-8da4w_output_8da8w-seq_8196.bundle

The model bundle file will be saved in the current directory with a .bundle extension.

Complete Example

Here's a complete example showing the full workflow:

# 1. Install and authenticate
pip install leap-bundle
leap-bundle login <api-key>
leap-bundle whoami

# 2. Create a bundle request
leap-bundle create <model-directory>

# 3. Monitor the request (repeat until completed)
leap-bundle list

# 4. Download when ready
leap-bundle download <request-id>

# 5. Your bundle file is now ready to use!
ls -la <downloaded-bundle-file>

Next Steps

Commands

Command Description
leap-bundle login Authenticate with LEAP using API token
leap-bundle whoami Show current authenticated user
leap-bundle logout Logout from LEAP
leap-bundle config Show current configuration
leap-bundle validate Validate directory for bundle creation
leap-bundle create Submit new bundle request
leap-bundle resume Resume an interrupted bundle request creation
leap-bundle list List all bundle requests or a specific request
leap-bundle cancel Cancel a bundle request
leap-bundle download Download the bundle file for a specific request

CHANGELOG

https://leap.liquid.ai/docs/leap-bundle/changelog

License

LFM Open License v1.0

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

leap_bundle-0.5.0.tar.gz (18.7 kB view details)

Uploaded Source

Built Distribution

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

leap_bundle-0.5.0-py3-none-any.whl (26.4 kB view details)

Uploaded Python 3

File details

Details for the file leap_bundle-0.5.0.tar.gz.

File metadata

  • Download URL: leap_bundle-0.5.0.tar.gz
  • Upload date:
  • Size: 18.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.18

File hashes

Hashes for leap_bundle-0.5.0.tar.gz
Algorithm Hash digest
SHA256 4ab169b64e287bba0766a518b29d4915cdd978a29f0ae7b6f7a5800d2611edee
MD5 36ab44750798e6740f0ed2e1d0620d6b
BLAKE2b-256 21088f573cf6242afb0a11a0d02cc9687fe641c61cf64d404183d274e0b8e8ec

See more details on using hashes here.

File details

Details for the file leap_bundle-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: leap_bundle-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 26.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.18

File hashes

Hashes for leap_bundle-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 7d60b6eff5617865523f45dd6a67e7a4c5bcb0900b2623fd1ed4101defe1bb2b
MD5 66fd046e3f5d7f72051b7e47c3d63fc4
BLAKE2b-256 56b029bd50878f752a1f9271982f3a4c2179181366fdcf921c85536af161a485

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