README.md

Cognit Device Runtime Example

This folder contains examples of the usage of the COGNIT library

Minimal example

The file minimal_offload_sync emonstrates the basic usage of the COGNIT library. In this example, you’ll learn how to upload requirements to the COGNIT environment and execute functions within it.

Uploading requirements

Requirements can be uploaded in two ways:

1. Using the init() function with a JSON object:

   my_device_runtime.init(TEST_REQS_INIT)

2. Using the call() function, with an optional parameter new_reqs to update the requirements on-the-fly:

   my_device_runtime.call(multiply, 2, 3, new_reqs=TEST_REQS_INIT)

This example also shows that requirements can be updated dynamically whenever needed.

Running the script

To execute the script, navigate to the examples directory and run the following command:

cd ./examples
python3 minimal_offload_sync.py

Run example with Docker

This example can also be executed within Docker. A Dockerfile named minimal_offload_sync.dockerfile is provided to build the image along with a Docker Compose file to help run it.

Steps to run with Docker

1. Install Docker

   Follow the official Docker installation instructions: Docker Installation Guide

2. Deploy Docker stack

   To build and run the image, make sure you are located in the examples directory. Then type the following commands:

   cd ./examples
   docker compose build
   docker compose up

Important
Make sure the configuration file cognit-template.yml has the correct parameters.