Setup - Interactml/iml-unreal GitHub Wiki
Installation
The InteractML Plugin is available for free on the 🔗Unreal Marketplace.
- Open the Epic Games Launcher
- On the Marketplace tab search for InteractML
- Go through the 'add to cart' and 'purchase' procedure (it's free)
- In the Library tab
- Locate the InteractML plugin in the Vault section
- Click the "Install To Engine" button
- Select the Unreal Engine version you want to use it with
- Click Install
- Once installation is complete you are ready to use it in your projects
Project
Enabling the plugin for use in a new or existing project is straightforward:
- Create new project / open existing project
- Open the Plugins window (Edit menu --> Plugins)
- Select the Machine Learning sub-section of the Installed plugins
- Click the Enabled checkbox on the InteractML plugin entry
- Accept the "Beta Version" warning popup (Yes)
- Click the Restart Now button at the bottom of the Plugin window (adding plugins requires a restart)
- Close the Plugins window
- You are now ready to use InteractML!
Minimal Viable Example
It's fairly easy to set up a minimal viable test case as follows:
- Create a new InteractML Training Set asset
- Right click in Content Browser
- Select Training Set from the Interact ML submenu.
- Rename it (e.g. MyTrainingSet)
- Create a new InteractML Classification Model asset
- Right click in Content Browser
- Select Classification Model from the Interact ML submenu.
- Rename it (e.g. MyModel)
- Locate the Character Blueprint you are using
- E.g. in the First Person Game Template it's in
FirstPersonBP/Blueprints/FirstPersonCharacter
- Open the blueprint (by double clicking on it)
- E.g. in the First Person Game Template it's in
- Add some extra variables to the Blueprint
- A float variable called "ExpectedOutput"
- A Boolean variable called "Recording"
- A Boolean variable called "Training"
- Ensure you are on the Event Graph tab
- Add a node graphs like the ones shown below (type "InteractML" in the node menu to find the custom nodes)
- Set the Training Set input of the Example Recorder node to the Training Set asset you created above
- Set the Model and Training Set inputs of the Teach The Machine node to the assets you created above
- Set the Model input of the Machine Learning Robot to the Model asset you created above
- Click Save and Compile
- Press Play to test it
Instructions
- Press 'R' to record a player position
- Press '4' and '5' to change the current Expected Output value
- Record some more locations with different Outputs (training and running is automatic)
- Revisit the recorded locations and the output displayed at the top-left should change
Graphs
The main Recording, Training, and Running functionality.
images/ui/Example_MinimalMachineLearning.png
The user interaction functionality.
images/ui/Example_MinimalInteraction1.png
images/ui/Example_MinimalInteraction2.png
Source
If you require access to the full source for the plugin and example projects have a look at 🔗the InteractMLUE repository.
👈 [Team and Terms]] ](/Interactml/iml-unreal/wiki/🏠-[[Home) | Machine Learning 👉