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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: tira-0.0.40.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.40.tar.gz
Algorithm Hash digest
SHA256 90b6e308cfeca8012c706706ad493ff25e680bf9c3784804bff47476ce133be2
MD5 d8720a46e9bd9b9c9886479d87c17066
BLAKE2b-256 6adfaefd26896f568b7f8caeac600d2ec5cc20302268b4edfa4bcf78d3e97305

See more details on using hashes here.

File details

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

File metadata

  • Download URL: tira-0.0.40-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.40-py3-none-any.whl
Algorithm Hash digest
SHA256 6d80896e513fd967ac38d80599425b89c56eeeff6c015efb07ac246fe22f6050
MD5 0076f03d29d6675670d6f1271991e929
BLAKE2b-256 4410d77190e3ae745446a685f3136d1996e1e942e627bc3ff9a22154421cf286

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