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

Feat/terms: Introduce Term data model for standardized tags and features #12

Merged
merged 6 commits into from
Aug 29, 2024

Conversation

mbsantiago
Copy link
Owner

This pull request introduces a new data model called "Term". This model aims to standardize tags and features within the soundevent package. Previously, features and tags relied on single string values ("name" and "key" respectively), which could lead to inconsistencies in how data is described.

With the introduction of the Term object, Tag and Feature now utilize terms instead of simple strings. The Term object includes valuable metadata like a definition, a URI for unique identification and linking to standards, and other optional fields for specifying usage.

Additionally, a few common terms have been created in the soundevent.term module. This collection will be expanded in the future.

These changes are designed to be non-breaking. However, a deprecation warning has been added for those who haven't adopted the new Term classes yet. All tests and documentation have been updated to reflect these changes.

Key Changes:

New Data Model: Introduced the Term data model.
Tag and Feature Updates: Modified Tag and Feature to use Term instead of string-based namespaces.
Common Terms: Created a set of common terms in the soundevent.term module.
Deprecation Warnings: Added deprecation warnings for legacy usage.
Updated Tests and Documentation: Ensured all tests and documentation are aligned with the new changes.

Benefits:

Improved Consistency: Standardizes tag and feature naming, reducing ambiguity and confusion.
Enhanced Interoperability: Facilitates data sharing and integration by using common vocabulary.
Alignment with Best Practices: Leverages established metadata standards

Copy link

codecov bot commented Aug 29, 2024

Codecov Report

Attention: Patch coverage is 91.56627% with 14 lines in your changes missing coverage. Please review.

Project coverage is 87.70%. Comparing base (6e49d19) to head (b00261a).
Report is 7 commits behind head on main.

Files with missing lines Patch % Lines
src/soundevent/data/features.py 84.61% 1 Missing and 3 partials ⚠️
src/soundevent/data/tags.py 85.71% 1 Missing and 3 partials ⚠️
src/soundevent/io/crowsetta/labels.py 60.00% 2 Missing and 2 partials ⚠️
src/soundevent/plot/geometries.py 0.00% 1 Missing ⚠️
src/soundevent/plot/tags.py 0.00% 1 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##             main      #12      +/-   ##
==========================================
+ Coverage   87.47%   87.70%   +0.22%     
==========================================
  Files         101      108       +7     
  Lines        3075     3164      +89     
  Branches      499      515      +16     
==========================================
+ Hits         2690     2775      +85     
+ Misses        306      304       -2     
- Partials       79       85       +6     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@mbsantiago mbsantiago merged commit df5aee7 into main Aug 29, 2024
15 checks passed
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.

1 participant