Commit 7008c320 authored by Dan Wilcox's avatar Dan Wilcox
Browse files

updated readme

parent d3a05ea8
Language Identifier
===================
Identification of chosen languages from 5s long audio snippets and sent over OSC (Open Sound Control) messages.
Identification of chosen languages from 5s long audio snippets
This code base has been developed by [ZKM | Hertz-Lab](https://zkm.de/en/about-the-zkm/organization/hertz-lab) as part of the project [»The Intelligent Museum«](#the-intelligent-museum).
Please raise issues, ask questions, throw in ideas or submit code, as this repository is intended to be an open platform to collaboratively improve langugae identification.
Copyright (c) 2021 ZKM | Karlsruhe.
Copyright (c) 2021 Paul Bethge.
Copyright (c) 2021 Dan Wilcox.
BSD Simplified License.
Tested Platforms
----------------
Dependencies
------------
* MacBook Pro 2017, macOS 10.15 & openFrameworks 0.11.2
* MacBook Pro 2018, macOS 11.3.1 & openFrameworks 0.11.2
* [openFrameworks](https://openframeworks.cc/download/)
* openFrameworks addons:
- ofxOSC (included with oF)
- [ofxTensorFlow2](https://github.com/zkmkarlsruhe/ofxTensorFlow2)
* Pre-trained language id model(s) placed in `bin/data` (included in this repo)
Structure
---------
* src/: contains the C++ Code that interfaces with OpenFrameworks
* bin/: contains the SavedModels trained with TensorFlow2
* src/: contains the openFrameworks C++ code
* bin/data/model_*: contains the SavedModels trained with TensorFlow2
Installation
------------
Installation & Build
--------------------
Overview:
1. Follow the steps in the ofxTensorFlow2 "Installation & Build" section for you platform
2. Generate the project files for this folder using the OF ProjectGenerator
3. Build for your platform
### Generating Project Files
Project files are not included so you will need to generate the project files for your operating system and development environment using the OF ProjectGenerator which is included with the openFrameworks distribution.
To (re)generate project files for an existing project:
1. Click the "Import" button in the ProjectGenerator
2. Navigate to the project's parent folder ie. "apps/myApps", select the base folder for the example project ie. "LanguageIdentifier", and click the Open button
3. Click the "Update" button
As with all OpenFrameworks examples put this project to a folder where '../../../'
is the root folder of your OpenFrameworks installation.
If everything went Ok, you should now be able to open the generated project and build/run the example.
Run this code
-------------
### macOS
### Compile
Open the Xcode project, select the "LanguageIdentifier Debug" scheme, and hit "Run".
For a Makefile build, build and run an example on the terminal:
```shell
cd $ROOT_OF_THIS_PROJECT
make
cd LanguageIdentifier
make ReleaseTF2
make RunRelease
```
### Linux
### Execute
For a Makefile build, build and run an example on the terminal:
```shell
cd LanguageIdentifier
make Release
make RunReleaseTF2
```
make RunRelease
```
Usage
-----
The openFrameworks application runs the language identification model using audio input. The detection status and detected language is sent out using OSC (Open Sound Control) messages.
### OSC Communication
......@@ -59,6 +90,12 @@ Message specification:
- name: string, language map name
- confidence: float, confidence percentage 0 - 100
Tested Platforms
----------------
* MacBook Pro 2017, macOS 10.15 & openFrameworks 0.11.2
* MacBook Pro 2018, macOS 11.3.1 & openFrameworks 0.11.2
The Intelligent Museum
----------------------
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment