Skip to main content

Lightweight flopscope client — drop-in replacement with no numpy dependency

Project description

flopscope-client

PyPI version Python 3.10+ License: MIT

Lightweight drop-in replacement for flopscope that proxies all operations to a remote flopscope-server over ZMQ + msgpack.

flopscope-client provides the same import flopscope Python module as the main flopscope distribution, but with no NumPy dependency — it forwards every counted operation to a flopscope-server process. Use this in constrained environments where you want flopscope's FLOP-counting API but cannot ship numpy + the full library (e.g. sandboxed participant containers in the ARC Whitebox Estimation Challenge).

Install instead of, not alongside

flopscope-client occupies the same flopscope Python import namespace as the main package. The two are mutually exclusive — installing both leads to file-overlap in flopscope/. Choose one:

# Lightweight: client-only, no numpy
pip install flopscope-client

# Heavy: full library on the local machine
pip install flopscope

# Server-side: both flopscope + flopscope-server, pinned together
pip install "flopscope[server]"

Quick start

The client connects to a flopscope-server instance specified by the FLOPSCOPE_SERVER_URL environment variable:

export FLOPSCOPE_SERVER_URL=tcp://flopscope-server.example.com:15555
# or for a local UNIX socket:
export FLOPSCOPE_SERVER_URL=ipc:///tmp/flopscope.sock

Then use flopscope normally — the import path and API are identical to the main distribution:

import flopscope as flops
import flopscope.numpy as fnp

with flops.BudgetContext(flop_budget=1_000_000):
    a = fnp.array([1.0, 2.0, 3.0])
    b = fnp.array([4.0, 5.0, 6.0])
    result = fnp.add(a, b)   # round-trips to the server, runs there
    flops.budget_summary()

On the first request, the client performs a version handshake with the server. A version mismatch raises ConnectionError with both versions in the error message — keep flopscope-server and flopscope-client on the same release.

Differences from NumPy

The API mirrors NumPy, with one semantic difference worth knowing up front: flopscope arrays are immutable (like JAX). Item assignment and indexed in-place updates raise TypeError:

arr[i] = value      # TypeError: flopscope arrays are immutable
arr[i] += value     # same error — desugars to arr[i] = arr[i] + value

Build results functionally instead — collect the pieces in a list and fnp.stack(...) them, or use a whole-array update (arr = arr + x, which rebinds rather than mutates). See the Immutable arrays guide for the accumulation recipe.

When to choose this over the main flopscope install

Scenario Install
You want flopscope's API in a process that has full NumPy + scientific stack pip install flopscope
You're shipping a sandboxed container that must not contain numpy / scipy pip install flopscope-client
You're running the server side that hosts computation for many clients pip install flopscope-server (brings flopscope along)
You're deploying both sides on one machine, version-pinned pip install "flopscope[server]"

Architecture overview

┌─────────────────────────────┐         ZMQ + msgpack         ┌──────────────────────────────┐
│  flopscope-client process   │ ───────────────────────────▶  │  flopscope-server process    │
│  (sandbox; no numpy)        │                                │  (full flopscope + numpy)    │
│  `import flopscope as flops`│ ◀───────────────────────────  │  Executes ops, tracks budget │
└─────────────────────────────┘                                └──────────────────────────────┘

The client serializes each operation (op name, args, kwargs) as msgpack, sends it over the ZMQ REQ/REP socket, and decodes the response. Budget tracking, symmetry-aware FLOP counting, and operation-cost analytics all happen on the server side; the client just relays calls.

Related

License

MIT

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

flopscope_client-0.8.0rc1.tar.gz (134.3 kB view details)

Uploaded Source

Built Distribution

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

flopscope_client-0.8.0rc1-py3-none-any.whl (62.1 kB view details)

Uploaded Python 3

File details

Details for the file flopscope_client-0.8.0rc1.tar.gz.

File metadata

  • Download URL: flopscope_client-0.8.0rc1.tar.gz
  • Upload date:
  • Size: 134.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for flopscope_client-0.8.0rc1.tar.gz
Algorithm Hash digest
SHA256 1c1ee647497f4cc310d6a069953bc88e22107d16418522de0b6ec271fcc9864e
MD5 d6f2dd2d83915787d5bf94299c450222
BLAKE2b-256 a11d2a0789761c64c7606db1045778ad8de62f6eae9a19c23096b27433428f70

See more details on using hashes here.

Provenance

The following attestation bundles were made for flopscope_client-0.8.0rc1.tar.gz:

Publisher: pypi-publish.yml on AIcrowd/flopscope

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file flopscope_client-0.8.0rc1-py3-none-any.whl.

File metadata

File hashes

Hashes for flopscope_client-0.8.0rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 c06ef5631f0d7fd900d0e0ca23c26e29e63096b56c2f52a5df838e55489ebab2
MD5 5de2680bc1cfb7a928f5037db0db66d1
BLAKE2b-256 8c9c861d1897122f05e7719d73886c88a845eb231d29333aacd08d4577c91c5b

See more details on using hashes here.

Provenance

The following attestation bundles were made for flopscope_client-0.8.0rc1-py3-none-any.whl:

Publisher: pypi-publish.yml on AIcrowd/flopscope

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

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