Skip to content
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

Feature/SK-1356 | Added example of keyword detection using client api #805

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

carl-andersson
Copy link

This pull request to examples/pytorch-keyworddetection-api as a new example for keyword detection using PyTorch. The changes involve adding new files and new documentation.

New Example Script:

  • Added a new client script for keyword detection using Fedn. This script includes data loading (data.py), model training (defined in model.py), validation, and prediction functionalities.

Documentation Updates:

  • Updated the README file with instructions on setting up and running the keyword detection example, including prerequisites, environment setup, and usage instructions.

Data Handling:

  • Added a new data handling script that includes classes for background noise and keyword datasets, as well as functions for data loading and preprocessing.

Configuration Files:

  • Created a new environment configuration file for setting up the required dependencies using Conda.
  • Updated the .gitignore file to exclude data files and specific file types generated during the example execution.

API Client Setup:

  • Added a script to initialize the seed model and start a session using the FEDn API client.## Description

@carl-andersson carl-andersson added feature New feature or request minor labels Jan 30, 2025
@carl-andersson carl-andersson self-assigned this Jan 30, 2025
@carl-andersson carl-andersson changed the title Added example of keyword detection using client api | SK-1356 SK-1356 | Added example of keyword detection using client api Jan 30, 2025
@carl-andersson carl-andersson changed the title SK-1356 | Added example of keyword detection using client api Feature/SK-1356 | Added example of keyword detection using client api Jan 30, 2025
-------------

- `Python >=3.9, <=3.12 <https://www.python.org/downloads>`__
- `A project in FEDn Studio <https://fedn.scaleoutsystems.com/signup>`__
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

requires conda?

Copy link
Author

@carl-andersson carl-andersson Jan 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, but you can't install SOX via pip. So in that case you will need to run
brew install sox

-----------------------------

This is an example to showcase how to set up FEDnClient and use APIClient to setup and manage a training from python.
The machine learning project is based on the Speech Commands dataset from Google.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe add link to dataset explaination: https://huggingface.co/datasets/google/speech_commands

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request minor
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants