Python SDK reference

The Python SDK allows you to build Genius model in Python, send these models to an agent, and query the agent for inference or action selection. The Python SDK also has functionality for structure learning and parameter learning. The following pages provide a full reference to the SDK functions and their features:

• GeniusModel class - Used to build Genius models (model.GeniusModel)

• GeniusAgent class - Used to connect to a Genius agent, load models, and query the agent (agent.GeniusAgent).

• POMDPModel class - Used to build Genius POMDP models (pomdp.POMDPModel)

• utils - Utility and helper functions (utils)

Setup

Installation

To install the SDK use the pip package installer:

pip install genius-client-sdk

Checking the version

After installing the Genius SDK in your python environment, it is possible to check the version:

import genius_client_sdk
print(genius_client_sdk.__version__)

5.0.0

Connecting to an agent

After installing the package, you must connect to a Genius agent using the URL that was provided to you. The URL is composed of three components, each of which must be passed into the agent. For example, if your agent URL was https://my.agent.hostname, then you could connect to the agent with:

from genius_client_sdk.agent import GeniusAgent
from genius_client_sdk.auth import ApiKeyConfig
​
agent = GeniusAgent(
        agent_http_protocol="https",
        agent_hostname="my.agent.hostname",
        agent_port=443,
        auth_config=ApiKeyConfig(api_key="<YOUR_API_KEY>"))

This example is using the ApiKey authentication method. To see other options, check out the Quick Start.