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.41.tar.gz (23.2 kB view details)

Uploaded Source

Built Distribution

tira-0.0.41-py3-none-any.whl (27.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for tira-0.0.41.tar.gz
Algorithm Hash digest
SHA256 e8c2e6cd3da6253b8bb75fdead2b8b5169907b32978fea82296078c44159514d
MD5 93caa933c4dc1ce2806be7397d29803b
BLAKE2b-256 57ccdfacd2dc672023bb5f9d5d24d940edcb7a5d8449bc3dd2a770859c098c19

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for tira-0.0.41-py3-none-any.whl
Algorithm Hash digest
SHA256 6f0af88511e84f367e9ffcb8aae4699e4674c1530135864b0b15c2165c9dac8d
MD5 0d4a62182dd324c2eb221a8800f5913a
BLAKE2b-256 9fb73d4861d47c491d78f5cf29c1e58d79a771ad46c4e366a7e84da41a714208

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