Skip to content

Commit

Permalink
Updated README file
Browse files Browse the repository at this point in the history
  • Loading branch information
Vincenzo Barbuto authored and lhstrh committed May 1, 2024
1 parent 930d9d9 commit 8a583f2
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ reactor Microphone {
=}

reaction(shutdown) {=
print("*"*10 + " Shutting Down " + "*"*10)
print("*"*32 + " SHUTTING DOWN " + "*"*32)
self.thread_should_be_running.clear()
# self.audio_capture_thread.join()
=}
Expand Down
34 changes: 30 additions & 4 deletions examples/Python/src/AudioClassification/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,43 @@ The example comprises three reactors:

![Diagram of the Lingua Franca Program](./AudioClassification.svg "Diagram of the Lingua Franca Program")

## Install Dependencies
## Running Locally

The example utilizes several libraries, including `sounddevice`, `numpy`, and `tensorflow`. You can install them effortlessly by executing the command:
Before cloning this repository, you need to install and configure [Git LFS](https://git-lfs.github.com/) to handle large files. Follow the [installation instructions](https://docs.github.com/en/github/managing-large-files/installing-git-large-file-storage) to set up Git LFS on your system.

Once Git LFS is installed, you can clone the repository:

```bash
python3 -m pip install -r requirements.txt
git clone https://github.com/lf-lang/playground-lingua-franca.git
```

### Install Dependencies

The example requires several Python packages, including:

- `sounddevice`
- `numpy`
- `tensorflow`

To install the dependencies:

1. Navigate to the example directory:

```bash
cd examples/Python/src/AudioClassification
```

2. Install the required packages:

```bash
python3 -m pip install -r requirements.txt
```

This will install all the packages listed in `requirements.txt`.
> [!WARNING]
> Be sure that you are using the same Python version as Lingua Franca for building the program.

### Installing Tensorflow for Apple Silicon
#### Installing Tensorflow for Apple Silicon

Installing TensorFlow for Apple Silicon can be a bit challenging. Therefore, it's important to follow this guide closely. First, ensure you update your **Xcode Command Line Tools**. Open your terminal and execute the following command:
Expand Down

0 comments on commit 8a583f2

Please sign in to comment.