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

Uploaded Source

Built Distribution

tira-0.0.31-py3-none-any.whl (23.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: tira-0.0.31.tar.gz
  • Upload date:
  • Size: 20.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.31.tar.gz
Algorithm Hash digest
SHA256 d799c7d5938acad916d2f230b506fa1a82bc067d708fdb6a65e3e1b213a9579e
MD5 0efce7df2a2aea148b84c2d8d23ade3f
BLAKE2b-256 56ca6760f5c1ef6b7dc9e62c6cdecf34a5ff5413670f8ca828e60843f045e7a3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: tira-0.0.31-py3-none-any.whl
  • Upload date:
  • Size: 23.9 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.31-py3-none-any.whl
Algorithm Hash digest
SHA256 3d16d97c0b8c015ea28b8600c368a6578402f4789c88b1282e93055e5bf8d030
MD5 8d20a83c680163ce32f06a069fd760d2
BLAKE2b-256 3491d8912627e3fa87be993eb66607659f2d1a68d68e5fbf97ea384708ce8853

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