Skip to content

Conversation

@ATriantafyllopoulos
Copy link
Contributor

@ATriantafyllopoulos ATriantafyllopoulos commented Jul 15, 2025

This PR adds standard config files for the IS09-13 feature sets. The config files are all taken from the original repo with the only change being the use of external source and sink components for reading/writing.

Summary by Sourcery

Add standardized openSMILE config files for the IS09-13 feature sets, update the FeatureSet enum to include IS09--IS13, and include the new configs in the package distribution.

New Features:

  • Add FeatureSet enum entries for IS09 through IS13 with doc links and config paths
  • Provide openSMILE configuration files for IS09 emotion, IS10 paralinguistics (compatibility and core), IS11 speaker state, IS12 speaker trait compatibility, and IS13 ComParE (core, functionals, vocalist)

Enhancements:

  • Use external source and sink components across all new configs

Build:

  • Include config/is09-13 directory in package data

@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented Jul 15, 2025

Reviewer's Guide

This PR integrates support for the IS09–IS13 openSMILE feature sets by registering new FeatureSet values, packaging a new config directory, and importing the standard config files (adapted to external I/O) under opensmile/core/config/is09-13.

ER diagram for FeatureSet and config files

erDiagram
    FEATURESET ||--o{ CONFIG_FILE : uses
    FEATURESET {
        string name
        string config_path
    }
    CONFIG_FILE {
        string filename
        string path
    }
Loading

Class diagram for updated FeatureSet enum

classDiagram
    class FeatureSet {
        <<enum>>
        ComParE_2016
        GeMAPS
        eGeMAPS
        emobase
        IS09
        IS10
        IS11
        IS12
        IS13
    }
Loading

File-Level Changes

Change Details Files
Extend FeatureSet enum to include IS09–IS13
  • Added new enum members IS09, IS10, IS11, IS12, IS13
  • Inserted corresponding Sphinx documentation links
  • Updated enum value mappings to point at is09-13 paths
opensmile/core/define.py
Include is09-13 configs in packaged data
  • Added "config/is09-13/*" to setup.py package_data
setup.py
Add IS09–IS13 configuration files
  • Imported and adapted official openSMILE configs for IS09 (emotion), IS10 (paraling), IS11 (speaker state), IS12 (speaker trait), IS13 (ComParE)
  • Replaced internal source/sink components with external placeholders
  • Organized configs into .conf and .inc files under opensmile/core/config/is09-13
opensmile/core/config/is09-13/*

Possibly linked issues

  • WIP: Init #1: The PR adds IS10_paraling config with external source/sink, directly addressing the issue's request and error.

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @ATriantafyllopoulos - I've reviewed your changes - here's some feedback:

  • Consider splitting this large PR into smaller, logical commits (e.g. enum updates, setup changes, then each feature‐set config) to make the review more manageable.
  • There’s substantial repetition across the new config files; extract shared headers and repeated component definitions into common include files to reduce duplication and simplify future maintenance.
  • In setup.py, ensure the 'config/is09-13/' glob recursively captures all nested directories and files (or switch to a '**/' pattern) so no configs are accidentally omitted.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider splitting this large PR into smaller, logical commits (e.g. enum updates, setup changes, then each feature‐set config) to make the review more manageable.
- There’s substantial repetition across the new config files; extract shared headers and repeated component definitions into common include files to reduce duplication and simplify future maintenance.
- In setup.py, ensure the 'config/is09-13/*' glob recursively captures all nested directories and files (or switch to a '**/*' pattern) so no configs are accidentally omitted.

## Individual Comments

### Comment 1
<location> `opensmile/core/config/is09-13/IS12_speaker_trait_compat.conf:339` </location>
<code_context>
+instance[melspecMfcc].type=cMelspec
+instance[mfcc].type=cMfcc
+
+[melspecMfcc:cMelspec]
+reader.dmLevel=fftmagH25
+writer.dmLevel=melspecMfcc
+copyInputName = 1
+processArrayFields = 1
+; htk compatible sample value scaling
+htkcompatible = 1
+nBands = 26s
+; use power spectrum instead of magnitude spectrum
+usePower = 1
</code_context>

<issue_to_address>
Possible typo: 'nBands = 26s' contains an unexpected 's'.

Please check if 'nBands' should be set to an integer value, such as 26, instead of '26s'.
</issue_to_address>

<suggested_fix>
<<<<<<< SEARCH
nBands = 26s
=======
nBands = 26
>>>>>>> REPLACE

</suggested_fix>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@hagenw
Copy link
Member

hagenw commented Jul 22, 2025

@ATriantafyllopoulos what is the usecase for those configs?

/cc @ureichel @maxschmitt

@ATriantafyllopoulos
Copy link
Contributor Author

@ATriantafyllopoulos what is the usecase for those configs?

/cc @ureichel @maxschmitt

I want to finally make a paper I wrote for Interspeech last year fully reproducible..

Also, these are the standard config files used in the early versions of the ComParE challenge. If someone wants to reproduce these results with modern tools (Python), this will be useful

@codecov
Copy link

codecov bot commented Jul 25, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.0%. Comparing base (9d7fd3d) to head (cf378dc).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
Files with missing lines Coverage Δ
opensmile/core/define.py 100.0% <100.0%> (ø)
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@hagenw
Copy link
Member

hagenw commented Jul 25, 2025

codespell is currently failing with

image

An easy fix would be to add the whole config folder to the skip entry in the [tool.codespell] section in pyproject.toml:

# ----- codespell ---------------------------------------------------------
[tool.codespell]
builtin = 'clear,rare,informal,usage,names'
skip = './opensmile.egg-info,./build,./docs/api,./docs/_templates,./docs/examples','opensmile/core/config'

@hagenw
Copy link
Member

hagenw commented Jul 25, 2025

For the other linter fix you need to run ruff or pre-commit locally, see https://audeering.github.io/opensmile-python/contributing.html#coding-convention

@ATriantafyllopoulos
Copy link
Contributor Author

An easy fix would be to add the whole config folder to the skip entry in the [tool.codespell] section in pyproject.toml:

# ----- codespell ---------------------------------------------------------
[tool.codespell]
builtin = 'clear,rare,informal,usage,names'
skip = './opensmile.egg-info,./build,./docs/api,./docs/_templates,./docs/examples','opensmile/core/config'

cf378dc (the syntax for the fix was a bit different but I followed your recommendation)

@hagenw
Copy link
Member

hagenw commented Jul 31, 2025

Great, thanks for fixing the tests, I will merge this now and prepare a new release.

@hagenw hagenw merged commit 4074ec2 into audeering:main Jul 31, 2025
19 checks passed
@hagenw
Copy link
Member

hagenw commented Jul 31, 2025

Maybe the README is still slightly misleading:

image

But doesn't matter, I released version 2.6.0, so you should now be able to use your configs by installing this package.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants