singularitynet/alpha-service-example repository overview

⁠alpha-service-example

Simple image classification service compatible with the alpha SingularityNET daemon

⁠Getting Started

⁠Prerequisites

• Python 3.6.5⁠

⁠Installing

• Clone the git repository

$ git clone [email protected]:singnet/alpha-service-example.git
$ cd alpha-service-example

• Install the dependencies

$ pip install -r requirements.txt

⁠Configuration

• The following default configuration can be overridden by populating configuration/config.json in the source tree with the desired values

{
  "SERVER_PORT": 5001,
  "MINIMUM_SCORE": 0.20,
  "LOG_LEVEL": 10
}

• SERVER_PORT: the port on which the example service will listen for incoming JSON-RPC calls over http
• MINIMUM_SCORE: the minimum confidence score (between 0 and 1 inclusive) required to return a given prediction
• LOG_LEVEL: the logging verbosity

⁠Running

⁠Standalone

• Invoke the example service directly

$ python image_classification_service

⁠With SingularityNET Daemon

⁠SingularityNET Daemon Configuration

• The following configuration values should be populated in a file (e.g. snetd.config) as described

{
  "DAEMON_LISTENING_PORT": 5000,
  "ETHEREUM_JSON_RPC_ENDPOINT": "",
  "AGENT_CONTRACT_ADDRESS": "",
  "PASSTHROUGH_ENDPOINT": "",
  "PASSTHROUGH_ENABLED": true,
  "BLOCKCHAIN_ENABLED": true,
  "LOG_LEVEL": 10,
  "PRIVATE_KEY": "",
  "HDWALLET_MNEMONIC": "",
  "HDWALLET_INDEX": 0
}

• DAEMON_LISTENING_PORT: the port on which the daemon will listen for incoming JSON-RPC calls over http (must differ from SERVER_PORT in the service configuration)
• ETHEREUM_JSON_RPC_ENDPOINT: the Ethereum node the daemon should run its blockchain client against (i.e. geth, ganache, infura; only applicable if BLOCKCHAIN_ENABLED)
• AGENT_CONTRACT_ADDRESS: the address of the Agent contract instance associated with this service (only applicable if BLOCKCHAIN_ENABLED)
• PASSTHROUGH_ENDPOINT: the endpoint on which the service is configured to listen for incoming JSON-RPC calls over http
• PASSTHROUGH_ENABLED: whether the daemon delegates calls to service or echoes requests back to the client (should be true)
• BLOCKCHAIN_ENABLED: whether the daemon validates and completes calls against the blockchain
• LOG_LEVEL: the logging verbosity of the daemon
• PRIVATE_KEY: the hex-encoded private key for the account that the daemon should use to transact on the blockchain (takes precedence if both PRIVATE_KEY and HDWALLET_MNEMONIC are provided)
• HDWALLET_MNEMONIC: the bip39⁠ mnemonic corresponding with the root seed for the bip32⁠ wallet from which the daemon's account should be derived
• HDWALLET_INDEX: the index of the account that the daemon should use to transact on the blockchain

⁠Running Service + Daemon on Host

• Invoke the run-snet-service script which launches both snetd and the example service

$ ./scripts/run-snet-service --daemon-config-path /path/to/config

⁠Running Service + Daemon in Docker Container

• Ensure that PASSTHROUGH_ENDPOINT is configured to be "http://127.0.0.1:5001⁠" in your daemon configuration
• Run the docker image with your daemon configuration (where HOST_PORT is the port you want the daemon bound to on your host)

$ docker run --detach -p HOST_PORT:DAEMON_LISTENING_PORT -v /path/to/config:/snetd.config singularitynet/alpha-service-example:latest

⁠Testing

• Invoke the test-call script against a running instance of the example service

$ ./scripts/test-call

⁠Building Docker Image

• Invoke the docker build script

$ ./scripts/build-docker

⁠License

This project is licensed under the MIT License - see the LICENSE⁠ file for details.