Development¶

This document should help to setup a local environment for development.

Prepare local setup¶

Download the MNIST-dataset and place them anywhere

For testing the standard MNIST-dataset is used. Download the 4 files somewhere from the web:

wget https://storage.googleapis.com/cvdf-datasets/mnist/train-images-idx3-ubyte.gz
wget https://storage.googleapis.com/cvdf-datasets/mnist/train-labels-idx1-ubyte.gz
wget https://storage.googleapis.com/cvdf-datasets/mnist/t10k-images-idx3-ubyte.gz
wget https://storage.googleapis.com/cvdf-datasets/mnist/t10k-labels-idx1-ubyte.gz
gzip -d train-images-idx3-ubyte.gz
gzip -d train-labels-idx1-ubyte.gz
gzip -d t10k-images-idx3-ubyte.gz
gzip -d t10k-labels-idx1-ubyte.gz

Copy example-config diretory to /etc/ and make sure, that the current user has access to the directory

sudo cp -r ./OpenHanami/example_configs/openhanami

sudo chown -R $(id -u):$(id -g) /etc/openhanami

In file /etc/openhanami/hanami_testing.conf update the path to the 4 MNIST files, so they point to the MNIST-files, which you downloaded eralier.

Run project locally for testing¶

Build the components of the project with the build-guide
For the initial run, environment-variables have to be set to initialize the sqlite-database and create the first admin-user:
```
export HANAMI_ADMIN_USER_ID=asdf
export HANAMI_ADMIN_USER_NAME=asdf
export HANAMI_ADMIN_PASSPHRASE=asdfasdf
```
These are the default testing-configs, to match with the test-confic /etc/openhanami/hanami_testing.conf.
Exectute the binary without any flags. It uses by default the config of /etc/openhanami/hanami.conf and the values of the example-config are enough for testing. The SQLite-database-file /etc/openhanami/hanami_db is automatically created by the initial start.

Testing¶

Run the compiled hanami-binary.

Python-SDK-Test¶

There is a python-script, which uses the python-version fo the SDK to run basic tests against the API.

install python and protobuf:

sudo apt-get install python3 python3-pip python3-venv protobuf-compiler

go into the test-directory

cd OpenHanami/testing/python_sdk_api

create and prepare python-env and install packages

python3 -m venv hanami_env

source hanami_env/bin/activate

cd OpenHanami/src/sdk/python/hanami_sdk

pip3 install -r requirements.txt

build proto-buffer messages

cd OpenHanami/src/sdk/python/hanami_sdk/hanami_sdk

protoc --python_out=. --proto_path ../../../../libraries/hanami_messages/protobuffers  hanami_messages.proto3

run tests

cd OpenHanami/testing/python_sdk_api

./sdk_api_test.py

Go-CLI-Test¶

install go and protobuffer-compiler

apt-get install -y wget protobuf-compiler golang-goprotobuf-dev

wget -c https://go.dev/dl/go1.22.5.linux-amd64.tar.gz

tar -C /usr/local/ -xzf go1.22.5.linux-amd64.tar.gz

go to the location
```
cd OpenHanami/testing/go_cli_api
```

export environment-variables

export HANAMI_ADDRESS=http://127.0.0.1:11418
export HANAMI_USER=asdf
export HANAMI_PASSPHRASE=asdfasdf

export train_inputs=/tmp/train-images-idx3-ubyte
export train_labels=/tmp/train-labels-idx1-ubyte
export request_inputs=/tmp/t10k-images-idx3-ubyte
export request_labels=/tmp/t10k-labels-idx1-ubyte

(of course update the values for your specific setup)

run script to build the cli and copy it to the current directory
```
./build_and_copy_cli.sh
```
run test-script
```
cli_test.sh
```