Skip to main content

Command line tool to create model bundles or download GGUF models 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.

It also supports downloading GGUF models directly from JSON manifest files.

See the documentation for more details.

Installation

pip install leap-bundle

Quick Start for GGUF Model Download

leap-bundle download <manifest-url>

Example with a HuggingFace URL:

leap-bundle download https://huggingface.co/LiquidAI/LeapBundles/blob/main/LFM2-Audio-1.5B-GGUF/F16.json

The command will:

  1. Create an output directory based on the URL or according to --output-path if specified.
  2. Download the JSON manifest file.
  3. Download all model files referenced in the manifest.
  4. Update the manifest to use relative paths to the downloaded files.

Quick Start for Model Bundling

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 bundle file for a request, or download GGUF models from a JSON manifest URL

CHANGELOG

https://docs.liquid.ai/leap/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.7.0.tar.gz (23.9 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.7.0-py3-none-any.whl (33.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for leap_bundle-0.7.0.tar.gz
Algorithm Hash digest
SHA256 0fff2d5fb2315611abf45620be286e27d27054faf3464f7cf27fe53a39228e17
MD5 156d8fc5510c9b86f8ad6d19e2949c41
BLAKE2b-256 330c4772fab1dedd70ae5159d124d24ee7d960ad80338f036c91911916c3d98b

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for leap_bundle-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8c34ac4a1de0cc143148260e8836f8e235e4b78bc89cf7af51e0c07b3ec3ec30
MD5 74881667ed9f07c18dfcfc2fa706d23b
BLAKE2b-256 30354b18e4d568f8c123d6f958c6a5a607e33005f9230adcbbcac47afee20257

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