NRN Agents Docs
  • Overview
    • Introduction
    • Installation & Setup
  • Admin
    • Overview
    • Model Architectures
    • Register
    • Unregister
  • Getting Started
    • Basic Integration
    • State Space
    • Action Space
    • Data Collection
    • Model Initialization
    • Inference
Powered by GitBook
On this page
  • Javascript
  • Unity
  • Unreal
Export as PDF
  1. Admin

Register

PreviousModel ArchitecturesNextUnregister

Last updated 3 months ago

In order to register model architectures for a game on the NRN Agents platform, we will need to define a few parameters:

  • modelType: "neural-network" for Feedforward Neural Network or "simple" for Tabular Agent.

  • architectureId: The unique identifier you want to use for your model architecture.

  • inputDim: The number of features in the state space (i.e. the input dimensionality).

  • actions: The structure of the action space. Each action "head" is responsible for a portion of the action space. Thus, we have to define the list of actions that each head is able to execute.

Developers can register their models in a no-code environment on our

Javascript

Through the Javascript SDK developers can register as follows:

const { Registry } = require('nrn-agents');

Registry.setApiKey("my-admin-api-key");
const registry = new Registry("my-game-id");

const registrationInputs = {
    modelType: "simple",
    architectureId: "my-first-model",
    inputDim: 7,
    actions = {
        direction: ["up", "down", "idle"]
    }
}

await Registry.register(registrationInputs)

Unity

For Unity games, we created a component in the library that admins can add to the inspector. To use the registration component, follow these instructions:

  1. Select any game object in the scene

  2. In the Inspector, click Add Component and search for NrnAgents then proceed to select Registration

  3. Fill out all the appropriate parameters and then click the "Register" button

Below is a snapshot of what the registration component looks like in the Unity inspector.

Unreal

Not yet implemented. The NRN team will handle registration for the time being.

dashboard