Skip to main content

Simple access to the TIRA API.

Project description

The TIRA Client

This is a python client for TIRA.io.

Download The results of some Submission

from tira.rest_client_api import Client

tira = Client()
output = tira.get_run_output('<task>/<team>/<approach>', '<dataset>')

Export datasets

You can export datasets if you are the owner or if the dataset is public. Export a dataset via the cli:

tira-run --export-dataset '<task>/<tira-dataset>' --output-directory tira-dataset

Export a dataset via the python API:

from tira.rest_api_client import Client

tira = Client()
tira.download_dataset('<task>', '<tira-dataset>')

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

Uploaded Source

Built Distribution

tira-0.0.53-py3-none-any.whl (31.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for tira-0.0.53.tar.gz
Algorithm Hash digest
SHA256 1a5663ed08543fcbdf551d0f2a05134d4febf26b2f79ffccd50f87c002aeb891
MD5 2867bcc43ebb918746bb6e44a7ae2dc1
BLAKE2b-256 c3bb08965edef07a733526f591f5596dbd7f80bb552d2bdb27bc66261fbafe12

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for tira-0.0.53-py3-none-any.whl
Algorithm Hash digest
SHA256 80fa8a8eaf2117f695ab2c741075514e880d29aab4d0b62169e2de9fc22e147b
MD5 a23ac667a6dd374e98ccdf61f914c011
BLAKE2b-256 c166069dd53b285f12adbb4c8f2e310c35077bbafb2c43bbf99c9018dffd3805

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