Skip to main content

Simple access to the TIRA API.

Project description

Running Jupyter Notebooks with TIRA

docker build -t tira/submission-base-image:1.0.0 -f Dockerfile .

Testing the model locally can be done using the following command:

tira-run \
  --input-directory ${PWD}/input \
  --output-directory ${PWD}/output \
  --image tira/submission-base-image:1.0.0 \
  --command 'tira-run-notebook --input $inputDataset --output $outputDir /workspace/template-notebook.ipynb'

Afterwards you can push the image to TIRA

docker push tira/submission-base-image:1.0.0

and set the command:

tira-run-notebook --input $inputDataset --output $outputDir /workspace/template-notebook.ipynb

Finally, if the actual processing in notebook is toggled via is_running_as_inference_server() (as seen in the template notebook) and your notebook defines a function named predict in the format

def predict(input_list: List) -> List:

you can start an inference server for your model with:

PORT=8001

docker run --rm -it --init \
  -v "$PWD/logs:/workspace/logs" \
  -p $PORT:$PORT \
  tira/submission-base-image:1.0.0 \
  tira-run-inference-server --notebook /workspace/template-notebook.ipynb --port $PORT

Exemplary request for a server running on localhost:8001 are

# POST (JSON list as payload)
curl -X POST -H "application/json" \
  -d "[\"element 1\", \"element 2\", \"element 3\"]" \
  localhost:8001

and

# GET (JSON object string(s) passed to the 'payload' parameter)
curl "localhost:8001?payload=\"element+1\"&payload=\"element+2\"&payload=\"element+3\""

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tira-0.0.29.tar.gz (18.0 kB view details)

Uploaded Source

Built Distribution

tira-0.0.29-py3-none-any.whl (22.5 kB view details)

Uploaded Python 3

File details

Details for the file tira-0.0.29.tar.gz.

File metadata

  • Download URL: tira-0.0.29.tar.gz
  • Upload date:
  • Size: 18.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.10

File hashes

Hashes for tira-0.0.29.tar.gz
Algorithm Hash digest
SHA256 1496c286b0ff6814922a43b8c5ff47cb936592212a7f5195d016179017bd6598
MD5 34d89f98d05870832307634637a8e2eb
BLAKE2b-256 875dc94c0da5d43bf44066d018f9dae57edffadc6c605f0835587fb740b8ce4e

See more details on using hashes here.

File details

Details for the file tira-0.0.29-py3-none-any.whl.

File metadata

  • Download URL: tira-0.0.29-py3-none-any.whl
  • Upload date:
  • Size: 22.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.10

File hashes

Hashes for tira-0.0.29-py3-none-any.whl
Algorithm Hash digest
SHA256 f70436484f7303bd770e7654625ffb1b6f4109f5adee8739a3e346b4306c5a02
MD5 37f4af77eeb34b63f9c97aedc7475b27
BLAKE2b-256 c0225ce744b1ab298e4a4756addf7ab9ceb6997677c38c6221dfe6b80d9b0be2

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page