-
Notifications
You must be signed in to change notification settings - Fork 16
add Wekinator integration guide #63
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Draft
samamou
wants to merge
2
commits into
master
Choose a base branch
from
59-add-wekintor-integration-docs
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| --- | ||
| layout: default | ||
|
|
||
| title: "Integrating with Wekinator" | ||
| description: "Integrating with Wekinator" | ||
|
|
||
| nav_order: 2 | ||
| parent: Integrations | ||
|
|
||
| permalink: /integrations/wekinator.html | ||
| --- | ||
|
|
||
| # Integrating with Wekinator | ||
|
|
||
| [Wekinator](http://www.wekinator.org/) is a free and open-source software that allows you to use machine learning to build new musical instruments, gestural controllers, computer vision systems, and more. This guide explains how to integrate ossia score with Wekinator for interactive machine learning applications. | ||
|
|
||
| ## Setup | ||
|
|
||
| 1. Download and install Wekinator from [the official website](http://www.wekinator.org/downloads/) | ||
|
|
||
| 3. Create OSC devices in score to communicate with Wekinator | ||
|
|
||
| 2. Launch Wekinator and configure it to listen for OSC inputs, and/or output OSC messages | ||
|
|
||
| ## Basic Configuration | ||
|
|
||
| ### Setting up | ||
|
|
||
| In Wekinator, set the input port (default is 6448) and start listening. More on this [here](http://www.wekinator.org/detailed-instructions/#Wekinator8217s_default_OSC_messages) | ||
|
|
||
|  | ||
|
|
||
| In score, add a new [OSC device](https://ossia.io/score-docs/devices/osc-device.html) with the following settings: | ||
| - Name: a descriptive label of your choice (e.g., "wekinator") | ||
| - Device host: 127.0.0.1 or localhost | ||
| - Output port (device listening port): 6448 | ||
| - Input port (score listening port): 9997 | ||
|
|
||
|  | ||
|
|
||
| ## Sending data to Wekinator | ||
|
|
||
| To send input features to Wekinator for training, we will use the OSC address format that Wekinator expects: | ||
| - For input features: `/wek/inputs` | ||
| - Followed by an array of floating-point values | ||
|
|
||
|  | ||
|
|
||
| In the | ||
| - Right click on your OSC device, add a child `wek` of type container | ||
| - Right click on the container and add a child called `inputs`. Set the data type here to list (AKA an array) | ||
|
|
||
| Now you've configured your OSC message an the address of `/wek/inputs` and parameters. | ||
|
|
||
| Set the output address of your process to the OSC device, and press play! | ||
|
|
||
|  | ||
|
|
||
| Check whether your data is being sent from score, you should see the data in the device explorer | ||
|
|
||
|  | ||
|
|
||
| and received in Wekinator, green means it's receiving data. | ||
|
|
||
|  | ||
|
|
||
|
|
||
| ## Receiving outputs from Wekinator | ||
|
|
||
| 1. Configure Wekinator's output OSC messages (by default, `/wek/outputs`) | ||
|
|
||
|  | ||
|
|
||
| <!-- 2. In your score, create OSC output device for Wekinator's output messages: | ||
| ## Example: Training a gesture recognizer | ||
|
|
||
| 1. Set up Wekinator to receive pose recognition data from ossia score | ||
| 2. Train Wekinator with different gestures | ||
| 3. Use Wekinator's output to trigger events in score | ||
|
|
||
| Add example score / link from AI | ||
|
|
||
| --> | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| - Verify port numbers match between ossia score and Wekinator | ||
| - Check that message format matches Wekinator's expectations | ||
| - Make sure you're not using that port in another application! | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
shouldn't this be uncommented?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
still working on producing a meaningful example for output!