Skip to main content

Deploy image processing algorithms in FastAPI servers.

Project description

EPFL Center for Imaging logo

🪐 Imaging Server Kit

Run seamlessly interoperable algorithms on images using FastAPI.

Setup

Build the imaging-server-kit image with docker:

docker build -t imaging-server-kit:3.9 .

or build specific images:

docker build -t imaging-server-kit:3.10 --file Dockerfile-3.10 .
docker build -t imaging-server-kit:gpu --file Dockerfile-GPU .

Run an algorithm server

The server will be running on http://localhost:8000.

docker build -t serverkit/rembg .
docker run -it --rm -p 8000:8000 serverkit/rembg

Run an algorithm server with multiple algorithms

See deployment. The server will be running on http://localhost:7000.

Usage

Python client

Install the imaging-server-kit package with pip:

pip install git+https://gitlab.com/epfl-center-for-imaging/imaging-server-kit.git

Connect to an algorithm server and run algorithms from Python:

from imaging_server_kit import Client

client = Client()

client.connect("http://localhost:7000")

print(client.algorithms)
# [`rembg`, `stardist`, `sam2`]

data_tuple = client.run_algorithm(
    algorithm="rembg",
    image=(...),
    rembg_model_name="silueta",
)

More examples.

Napari client

Coming soon.

Web client

Coming soon.

QuPath client

Coming soon.

Fiji plugin

Coming soon.

Contributing

Contributions are very welcome.

License

This software is distributed under the terms of the BSD-3 license.

Issues

If you encounter any problems, please file an issue along with a detailed description.

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

imaging_server_kit-0.0.2.tar.gz (19.0 kB view details)

Uploaded Source

Built Distribution

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

imaging_server_kit-0.0.2-py3-none-any.whl (20.2 kB view details)

Uploaded Python 3

File details

Details for the file imaging_server_kit-0.0.2.tar.gz.

File metadata

  • Download URL: imaging_server_kit-0.0.2.tar.gz
  • Upload date:
  • Size: 19.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.9.21

File hashes

Hashes for imaging_server_kit-0.0.2.tar.gz
Algorithm Hash digest
SHA256 906c9e82c9a2a70e3a8245ec332ad44005e53c54ed4306edf96c0aa997a1a342
MD5 649fe982488f00941e15bb7d3a1360d5
BLAKE2b-256 6c737936d6391190c91c029466f77e4c45897cea73af1b2ba62c57a697f4b4dd

See more details on using hashes here.

File details

Details for the file imaging_server_kit-0.0.2-py3-none-any.whl.

File metadata

File hashes

Hashes for imaging_server_kit-0.0.2-py3-none-any.whl
Algorithm Hash digest
SHA256 1c2eb48055236373d7eb591facaf114f6b54226ea54f5611ad9a42b99121f411
MD5 bd4fc947b791f93da8a278da34cb844c
BLAKE2b-256 6924928d762d09aa4e0a3728260f4b0f8417c21bb5f711f6a4e494f92f7e8587

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